latestSwagger 2.02026-08-0982147352.7 KB

be66ed178abe

Enrollment

enrollment members

Enrollment members/demographics for a line of coverage.<p>Scopes: export_enrollment</p>

get/v{version}/companies/{company_id}/enrollments/members

Path parameters

company_idstring required

Id of the company.

versionstring required

Query parameters

plan_typestring

The plan type. Please see <a href="/api/docs/v2#section/Plan-Types">Plan Types</a> for a complete list of supported values.

datestring

The from date of the enrollments to include members for. Optional. Will include all if omitted.

start_idstring

The id to start fetching from. Optional.

limitinteger

Limits the number of records returned. Optional. The default is 50 and the maximum value is 250.

Response

Success

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.

Example response

{
  "data": [
    {
      "employee": {
        "birth_date": "yyyy-MM-dd",
        "status_effective_date": "yyyy-MM-dd",
        "latest_hire_date": "yyyy-MM-dd",
        "compensation_start_date": "yyyy-MM-dd",
        "compensation_end_date": "yyyy-MM-dd",
        "benefit_eligible_date": "yyyy-MM-dd",
        "hire_date": "yyyy-MM-dd",
        "termination_date": "yyyy-MM-dd",
        "cobra_date": "yyyy-MM-dd",
        "retire_date": "yyyy-MM-dd",
        "death_date": "yyyy-MM-dd",
        "original_hire_date": "yyyy-MM-dd",
        "cobra_end_date": "yyyy-MM-dd",
        "salary_effective_date": "yyyy-MM-dd"
      },
      "dependents": [
        {
          "birth_date": "yyyy-MM-dd",
          "graduation_date": "yyyy-MM-dd",
          "cobra_start_date": "yyyy-MM-dd",
          "cobra_end_date": "yyyy-MM-dd"
        }
      ]
    }
  ]
}