Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Group Policy Intents

Retrieve a group policy intent

Retrieves a group_policy_intent object.

get/group_policy_intents/{group_policy_intent_id}

Path parameters

group_policy_intent_idstring required
Example:gpi_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 intent

group_idstring required

Unique identifier for the group

plan_idstring required

Unique identifier for the plan

quote_intent_idstring required

Unique identifier for the group quote intent this policy intent was created from

status'processing' | 'action_required' | 'pending_provider_approval' | 'policy_created' | 'expired' | 'provider_rejected' | 'manual_renewal_gathering_required' required
due_datestring date-time nullable

Due date for the policy intent

objectstring

Object type identifier

Example response

{
  "id": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "quote_intent_id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "due_date": "2024-12-01T00:00:00Z",
  "cost_sharing": {
    "member_count": {
      "adults": 123,
      "children": 123
    },
    "member_selection": {
      "partner": true,
      "children": true
    },
    "percentage": {
      "percentage": 123
    }
  },
  "action_required": {
    "due_by": "2024-12-01T00:00:00Z"
  }
}