v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB

Policies

List all policies

Returns a list of policies. By default, only active and scheduled policies are returned. Use the status query parameter to filter by other statuses. The policies are returned sorted by creation date, with the most recent policy appearing first.

get/policies

Query parameters

employee_idstring

Filters policies by employee.

Example:ee_3b1333d87d9d4fd6ad83ba7f6b0e951a

Filters policies by employee.

group_idstring

Filters policies by group.

Example:gr_3b1333d87d9d4fd6ad83ba7f6b0e951a

Filters policies by group.

group_policy_idstring

Filters policies by group policy.

Example:gp_3b1333d87d9d4fd6ad83ba7f6b0e951a

Filters policies by group policy.

statusstring

Multiple values can be provided by separating them with a comma. Allowed values are: scheduled, active, expired, cancelled.

pageinteger

The page of results to return. Defaults to 1 if not provided.

page_sizeinteger

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

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.

Response

pageinteger required

The current page of the results

page_sizeinteger required

The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size

total_countinteger required

The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.

has_next_pageboolean

Whether there are more pages available after this page

has_previous_pageboolean

Whether there are more pages available before this page

Example response

{
  "items": [
    {
      "id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "group_policy_id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "provider": {
        "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a"
      },
      "plan": {
        "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
      },
      "start_date": "2024-12-01",
      "end_date": "2024-12-01",
      "cancellation_date": "2024-12-01",
      "health_insurance": {
        "opt_out_deadline": "2024-12-01",
        "initial_dependents_update_deadline": "2024-12-01",
        "renewal": {
          "renewal_date": "2024-12-01",
          "window_start_date": "2024-12-01",
          "window_end_date": "2024-12-01",
          "renewed_policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a"
        },
        "dependents_supported": true,
        "configuration": {
          "cost_sharing": {
            "member_count": {
              "adults": 123,
              "children": 123
            },
            "member_selection": {
              "partner": true,
              "children": true
            },
            "percentage": {
              "percentage": 123
            }
          }
        },
        "members": [
          {
            "id": "pm_3b1333d87d9d4fd6ad83ba7f6b0e951a",
            "date_of_birth": "2024-12-01",
            "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a"
          }
        ],
        "estimated_gross_premium": {
          "monthly": {
            "employee_contribution": 123.45,
            "employer_contribution": 123.45,
            "total": 123.45
          },
          "term": {
            "employee_contribution": 123.45,
            "employer_contribution": 123.45,
            "total": 123.45
          }
        }
      }
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_count": 123,
  "has_next_page": true,
  "has_previous_page": true
}