Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Group Policies

Retrieve a group policy

Retrieves a group_policy object.

get/group_policies/{group_policy_id}

Path parameters

group_policy_idstring required
Example:gp_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.

Response

OK

idstring required

Unique identifier for the group policy. Prefixed with gp_.

group_idstring

Identifier for the group associated with this group policy.

employer_idstring

Identifier for the employer associated with this group policy.

start_datestring date required

Policy start (effective) date in ISO 8601 (YYYY-MM-DD).

end_datestring date nullable

Policy end date (inclusive) in ISO 8601 (YYYY-MM-DD), or null if open-ended.

cancellation_datestring date nullable

Policy cancellation date (inclusive) in ISO 8610 (YYYY-MM-DD), or null if not applicable.

status'scheduled' | 'active' | 'expired' | 'cancelled' required
type'health_insurance' | 'life_assurance' required
objectstring

The object type

Example response

{
  "id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "start_date": "2024-12-01",
  "end_date": "2024-12-01",
  "cancellation_date": "2024-12-01",
  "provider": {
    "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "plan": {
    "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "health_insurance": {
    "renewal": {
      "renewal_date": "2024-12-01",
      "window_start_date": "2024-12-01",
      "window_end_date": "2024-12-01",
      "renewed_policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    },
    "configuration": {
      "cost_sharing": {
        "member_count": {
          "adults": 123,
          "children": 123
        },
        "member_selection": {
          "partner": true,
          "children": true
        },
        "percentage": {
          "percentage": 123
        }
      }
    }
  }
}