Enrollments
List Enrollments
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
Enrollments
List Enrollments
Lists all enrollments under your provider.
GET
/
enrollments
curl --request GET \
--url https://sandbox.withclasp.com/enrollments \
--header 'Authorization: Bearer <token>'{
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"enrolled_plans": [
{
"id": "<string>",
"plan": "<string>",
"premium": "<string>",
"employer_contribution": "<string>",
"member_contribution": "<string>",
"payroll_provider_external_id": "<string>",
"enrolled_dependents": [
{
"id": "<string>",
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
}
}
],
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25"
}
],
"member": "<string>",
"reason": "new_child",
"category": "qle",
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"status": "<any>",
"created_at": "2023-11-07T05:31:56Z",
"coverage_waivers": [
{
"line_of_coverage": "accident",
"reason": "covered_as_dependent",
"member": "<string>",
"dependent": "<string>"
}
]
}
]
}Authorizations
API Key authentication with required prefix "Bearer"
Query Parameters
The pagination cursor value.
Number of results to return per page.
Response
200 - application/json
Maximum length:
255results.enrolled_plans.enrolled_dependents.primary_care_provider.is_existing_patient
boolean
required
Maximum length:
255Maximum length:
255Maximum length:
255Maximum length:
255qle- Qleopen_enrollment- Open Enrollmentcarrier_sync- Carrier Sync
Available options:
qle, open_enrollment, carrier_sync accident- Accidentaccidental_death- Accidental Death and Dismembermentcancer- Cancerdental- Dentaldependent_care_fsa- Dependent Care Flexible Spending Accounthealthcare_fsa- Healthcare Flexible Spending Accounthospital_indemnity- Hospital Indemnityhsa- Health Savings Accountlife- Lifelimited_purpose_fsa- Limited Purpose Flexible Spending Accountltd- Long Term Disabilitymedical- Medicalstd- Short Term Disabilityvision- Visionvoluntary_critical_illness- Voluntary Critical Illnessvoluntary_life- Voluntary Lifevoluntary_std- Voluntary Short Term Disability
Available options:
accident, accidental_death, cancer, dental, dependent_care_fsa, healthcare_fsa, hospital_indemnity, hsa, life, limited_purpose_fsa, ltd, medical, std, vision, voluntary_critical_illness, voluntary_life, voluntary_std covered_as_dependent- Covered As Dependentdifferent_employer_coverage- Different Employer Coverageother- Othermedicare_coverage- Medicare Coveragemedicaid_coverage- Medicaid Coverageindividual_policy_coverage- Individual Policy Coveragemilitary_coverage- Military Coveragestate_funded_plan_coverage- State Funded Plan Coverageno_coverage- No Coverage
Available options:
covered_as_dependent, different_employer_coverage, other, medicare_coverage, medicaid_coverage, individual_policy_coverage, military_coverage, state_funded_plan_coverage, no_coverage new_child- New Childadopted_child- Adopted Childmarriage- Marriagedependent_lost_coverage- Dependent Lost Coveragedependent_relocated_in_network- Dependent Relocated In Networkdependent_court_order- Dependent Court Orderdivorce- Divorcecarrier_sync- Carrier Syncdomestic_partnership- Domestic Partnershiprelocated- Relocatedlost_coverage- Lost Coveragedeath- Deathnew_hire- New Hireterminated- Terminatedrehire- Rehireopen_enrollment- Open Enrollment
Available options:
new_child, adopted_child, marriage, dependent_lost_coverage, dependent_relocated_in_network, dependent_court_order, divorce, carrier_sync, domestic_partnership, relocated, lost_coverage, death, new_hire, terminated, rehire, open_enrollment curl --request GET \
--url https://sandbox.withclasp.com/enrollments \
--header 'Authorization: Bearer <token>'{
"next": "<string>",
"previous": "<string>",
"results": [
{
"id": "<string>",
"enrolled_plans": [
{
"id": "<string>",
"plan": "<string>",
"premium": "<string>",
"employer_contribution": "<string>",
"member_contribution": "<string>",
"payroll_provider_external_id": "<string>",
"enrolled_dependents": [
{
"id": "<string>",
"plan": "<string>",
"dependent": "<string>",
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
}
}
],
"primary_care_provider": {
"id": "<string>",
"full_name": "<string>",
"is_existing_patient": true,
"provider_id_number": "<string>"
},
"effective_start": "2023-12-25",
"effective_end": "2023-12-25"
}
],
"member": "<string>",
"reason": "new_child",
"category": "qle",
"effective_start": "2023-12-25",
"effective_end": "2023-12-25",
"status": "<any>",
"created_at": "2023-11-07T05:31:56Z",
"coverage_waivers": [
{
"line_of_coverage": "accident",
"reason": "covered_as_dependent",
"member": "<string>",
"dependent": "<string>"
}
]
}
]
}