Retrieve a group quote intent

Retrieves a group_quote_intent object.

get/group_quote_intents/{group_quote_intent_id}

Path parameters

group_quote_intent_idstring required

Example:gqi_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

idstring required

Unique identifier for the group quote intent

type'single' | 'multi_level'

group_idstring nullable required

Unique identifier for the group. Null only on a multi-level intent, whose groups are on its levels.

plan_idstring nullable required

Unique identifier for the plan. Null only on a multi-level intent, whose plans are on its levels.

expected_start_datestring date nullable

Expected start date for the insurance coverage

objectstring

Object type identifier

Example response

{
  "id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "cost_sharing": {
    "member_count": {
      "adults": 123,
      "children": 123
    },
    "member_selection": {
      "partner": true,
      "children": true
    },
    "percentage": {
      "percentage": 123
    }
  },
  "expected_start_date": "2024-12-01",
  "items": [
    {
      "levels": [
        {
          "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
          "cost_sharing": {
            "member_count": {
              "adults": 123,
              "children": 123
            },
            "member_selection": {
              "partner": true,
              "children": true
            },
            "percentage": {
              "percentage": 123
            }
          },
          "coverage_selections": [
            {
              "configuration_id": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a",
              "options": [
                {
                  "option_id": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "action_required": {
    "due_by": "2024-12-01T00:00:00Z"
  }
}

Changes

Changed in 3 of the 11 revisions of this API.23

Sep 4, 202679cef5b382192See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
Sep 4, 20264017c7acef2d2See the full diff
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became nullable for the status
  response-property-became-nullable
Aug 7, 20267b8b3ed87c961See the full diff
- ○
  added the new optional header request parameter X-Platform-Id
  new-optional-request-parameter
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history