Skip to navigation
API ReferenceGroup Policies

Retrieve a group policy

Retrieves a group_policy object.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

group_policy_idstringRequiredformat: "gp_.+"

Headers

X-Platform-IdstringOptional

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
idstringformat: "gp_.+"

Unique identifier for the group policy. Prefixed with gp_.

start_datedate

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

statusenum

Current lifecycle state of the group_policy, indicating its progress from creation to activation. Possible values are:

  • scheduled: Group policy has been scheduled for activation.
  • active: Group policy is now active
  • expired: Group policy is no longer active as it reached its end date
  • cancelled: Group policy is now cancelled for any reason.
Allowed values:
typeenum

Policy type. Determines which sub-object is populated.

Allowed values:
providerobject
Provider information for this policy.
planobject
Plan information for this policy
linked_group_policy_idslist of strings

The other group_policy objects bought together with this one as a single scheme — the policies created from the same multi-level purchase. Always present, and empty for a policy with no siblings.

disclosureslist of objects
Disclosures associated with this group policy.
group_idstringOptionalformat: "gr_.+"
Identifier for the group associated with this group policy.
employer_idstringOptionalformat: "er_.+"
Identifier for the employer associated with this group policy.
end_datedate or nullOptional

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

cancellation_datedate or nullOptional

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

health_insuranceobjectOptional

Health insurance–specific fields (present when type=health_insurance).

life_assuranceobjectOptional

Life assurance–specific fields (present when type=life_assurance).

objectstringOptionalRead-only
The object type

Errors

404
Not Found Error