v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB

Groups

Check employee eligibility for a group

Checks whether an employee qualifies for a group without adding them to it. This is a dry-run eligibility check — the employee is not enrolled or added. The response includes provider and plan information.

post/groups/{group_id}/eligibility_check

Path parameters

group_idstring required

Example:gr_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request body

employee_idstring required

The employee to check eligibility for.

Example request

{
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a"
}

Response

objectstring

The object type.

eligibility_status'pending' | 'eligible' | 'ineligible' required

Example response

{
  "provider": {
    "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "plan": {
    "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  }
}