Connections
Retrieve Connection
API Reference
- Authentication
- Carriers
- Components (Embeddable UI)
- Connections
- Dependents
- Employer Documents
- Employers
- Enrollments
- Group Connections
- Members
- Pay Rates
- Payroll Benefits
- Groups
- Plans
- Plan Configurations
- Subclasses
- Tasks
- Reports
Connections
Retrieve Connection
Retrieves details for a single carrier connection.
GET
/
connections
/
{public_id}
curl --request GET \
--url https://sandbox.withclasp.com/connections/{public_id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"broker_url": "<string>",
"employer": "<string>",
"group_connections": [
{
"id": "<string>",
"carrier": "<string>",
"status": "pending",
"broker_federal_ein": "<string>",
"group_id": "<string>",
"connection": "<string>",
"initiated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"events": [
{
"id": "<string>",
"category": "initial_connection",
"status": "not_started",
"created_at": "2023-11-07T05:31:56Z"
}
],
"status": "<any>"
}Authorizations
API Key authentication with required prefix "Bearer"
Path Parameters
Response
200 - application/json
pending- Pendingprocessing- Processingneeds_attention- Needs Attentioncompleted- Completed
Available options:
pending, processing, needs_attention, completed Maximum length:
10Maximum length:
255initial_connection- Initial Connectionpayroll_accessed- Payroll Accessedpayroll_connected- Payroll Connectedbroker_link_generated- Broker Link Generatedcarrier_details_submitted- Carrier Details Submittedcarrier_sync_updated- Carrier Sync Updatedcarrier_sync_completed- Carrier Sync Completedreview_submitted- Review Submitted
Available options:
initial_connection, payroll_accessed, payroll_connected, broker_link_generated, carrier_details_submitted, carrier_sync_updated, carrier_sync_completed, review_submitted not_started- Not Startedpending- Pendingprocessing- Processingneeds_attention- Needs Attentionreview- Reviewcompleted- Completedinactive- Inactive
Available options:
not_started, pending, processing, needs_attention, review, completed, inactive Maximum length:
255curl --request GET \
--url https://sandbox.withclasp.com/connections/{public_id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"broker_url": "<string>",
"employer": "<string>",
"group_connections": [
{
"id": "<string>",
"carrier": "<string>",
"status": "pending",
"broker_federal_ein": "<string>",
"group_id": "<string>",
"connection": "<string>",
"initiated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"events": [
{
"id": "<string>",
"category": "initial_connection",
"status": "not_started",
"created_at": "2023-11-07T05:31:56Z"
}
],
"status": "<any>"
}