Skip to main content
GET
/
members
cURL
curl --request GET \
  --url https://sandbox.withclasp.com/members \
  --header 'Authorization: Bearer <token>'
{
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "dob": "2023-12-25",
      "employer": "<string>",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "zip_code": "<string>",
        "line2": "<string>"
      },
      "hire_date": "2023-12-25",
      "middle_name": "<string>",
      "ssn_last_four": "<string>",
      "email": "jsmith@example.com",
      "phone_number": "<string>",
      "enrollments": [
        "<string>"
      ],
      "termination_date": "2023-12-25",
      "payroll_provider_external_id": "<string>",
      "hours_worked": "<string>",
      "subclasses": [
        "<string>"
      ],
      "business_unit": "<string>",
      "job_title": "<string>",
      "is_union": true,
      "is_seasonal": true,
      "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

​
connection
string
​
cursor
string

The pagination cursor value.

​
employer
string
​
line_of_coverage
enum<string>
  • accident - Accident
  • accidental_death - Accidental Death and Dismemberment
  • cancer - Cancer
  • commuter_parking - Commuter Parking
  • commuter_transit - Commuter Transit
  • dental - Dental
  • dependent_care_fsa - Dependent Care Flexible Spending Account
  • healthcare_fsa - Healthcare Flexible Spending Account
  • hospital_indemnity - Hospital Indemnity
  • hsa - Health Savings Account
  • life - Life
  • limited_purpose_fsa - Limited Purpose Flexible Spending Account
  • long_term_disability - Long Term Disability
  • lump_sum_disability - Lump Sum Disability
  • medical - Medical
  • short_term_disability - Short Term Disability
  • supplemental - Supplemental
  • telemedicine - Telemedicine
  • vision - Vision
  • voluntary_accidental_death - Voluntary Accidental Death
  • voluntary_critical_illness - Voluntary Critical Illness
  • voluntary_life - Voluntary Life
  • voluntary_short_term_disability - Voluntary Short Term Disability
Available options:
accident,
accidental_death,
cancer,
commuter_parking,
commuter_transit,
dental,
dependent_care_fsa,
healthcare_fsa,
hospital_indemnity,
hsa,
life,
limited_purpose_fsa,
long_term_disability,
lump_sum_disability,
medical,
short_term_disability,
supplemental,
telemedicine,
vision,
voluntary_accidental_death,
voluntary_critical_illness,
voluntary_life,
voluntary_short_term_disability
​
page_size
integer

Number of results to return per page.

​
search
string

A search term. Searches first_name, last_name, and email.

Response

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