Skip to main content
GET
/
enrollments
/
{public_id}
cURL
curl --request GET \
  --url https://sandbox.withclasp.com/enrollments/{public_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "enrolled_plans": [
    {
      "id": "<string>",
      "enrollment": "<string>",
      "plan": "<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>"
          },
          "volume": "<string>",
          "requested_volume": "<string>",
          "volume_approved_at": "2023-11-07T05:31:56Z",
          "eoi_dismissed_at": "2023-11-07T05:31:56Z"
        }
      ],
      "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",
      "premium": "<string>",
      "employer_contribution": "<string>",
      "member_contribution": "<string>",
      "payroll_provider_external_id": "<string>",
      "volume": "<string>",
      "requested_volume": "<string>",
      "volume_approved_at": "2023-11-07T05:31:56Z",
      "eoi_dismissed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "member": "<string>",
  "effective_start": "2023-12-25",
  "effective_end": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "coverage_waivers": [
    {
      "member": "<string>",
      "dependent": "<string>"
    }
  ],
  "change_date": "2023-12-25",
  "qualifying_life_event_documents": [
    "<string>"
  ],
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.withclasp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

​
public_id
string
required

Response

200 - application/json
​
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
​
enrolled_plans
object[]
required
​
member
string
required
​
category
enum<string>
required
  • qle - Qle
  • open_enrollment - Open Enrollment
  • carrier_sync - Carrier Sync
Available options:
qle,
open_enrollment,
carrier_sync
​
effective_start
string<date>
required
​
effective_end
string<date>
required
​
status
enum<string>
required
read-only
  • not_started - Not Started
  • pending - Pending
  • approved - Approved
  • synced - Synced
  • cancelled - Cancelled
  • failed - Failed
Available options:
not_started,
pending,
approved,
synced,
cancelled,
failed
​
created_at
string<date-time>
required
read-only
​
coverage_waivers
object[]
required
​
reason
  • new_child - New Child
  • adopted_child - Adopted Child
  • marriage - Marriage
  • dependent_lost_coverage - Dependent Lost Coverage
  • dependent_gained_coverage - Dependent Gained Coverage
  • dependent_relocated_in_network - Dependent Relocated In Network
  • dependent_court_order - Dependent Court Order
  • divorce - Divorce
  • domestic_partnership - Domestic Partnership
  • relocated - Relocated
  • lost_coverage - Lost Coverage
  • death - Death
  • new_hire - New Hire
  • terminated - Terminated
  • rehire - Rehire
  • leave_of_absence - Leave Of Absence
  • open_enrollment - Open Enrollment
  • passive_open_enrollment - Passive Open Enrollment
  • employment_change - Employment Change
  • dependent_employment_change - Dependent Employment Change
  • new_eligibility - New Eligibility
  • gain_coverage - Gain Coverage
  • significant_plan_change - Significant Plan Change
  • dependent_aged_out - Dependent Aged Out
  • citizenship_change - Citizenship Change
  • release_from_incarceration - Release From Incarceration
  • tax_advantaged_contribution_change - Tax Advantaged Contribution Change
Available options:
new_child,
adopted_child,
marriage,
dependent_lost_coverage,
dependent_gained_coverage,
dependent_relocated_in_network,
dependent_court_order,
divorce,
carrier_sync,
domestic_partnership,
relocated,
lost_coverage,
death,
new_hire,
terminated,
rehire,
leave_of_absence,
open_enrollment,
passive_open_enrollment,
employment_change,
dependent_employment_change,
new_eligibility,
gain_coverage,
significant_plan_change,
dependent_aged_out,
citizenship_change,
release_from_incarceration,
tax_advantaged_contribution_change
​
change_date
string<date> | null
​
qualifying_life_event_documents
string[]
​
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.