Skip to main content
GET
/
enrollments
cURL
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>",
          "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",
          "premium": "<string>",
          "employer_contribution": "<string>",
          "member_contribution": "<string>",
          "payroll_provider_external_id": "<string>"
        }
      ],
      "member": "<string>",
      "category": "qle",
      "effective_start": "2023-12-25",
      "effective_end": "2023-12-25",
      "status": "not_started",
      "created_at": "2023-11-07T05:31:56Z",
      "coverage_waivers": [
        {
          "line_of_coverage": "accident",
          "reason": "covered_as_dependent",
          "member": "<string>",
          "dependent": "<string>"
        }
      ],
      "reason": "new_child",
      "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"

Query Parameters

cursor
string

The pagination cursor value.

page_size
integer

Number of results to return per page.

plan
string

Filter for enrollments that are enrolled in a specific plan.

employer
string

Filter for enrollments for a specific employer.

Response

200 - application/json
next
string | null
previous
string | null
results
object[]