List group policy intents

GET

/group_policy_intents

GET

/group_policy_intents

curl -G https://test.api.kota.io/group_policy_intents \
     -H "Authorization: Bearer <apiKey>" \
     -d group_id=gr_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -d plan_id=pl_3b1333d87d9d4fd6ad83ba7f6b0e951a

200Retrieved

{
  "items": [
    {
      "id": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "quote_intent_id": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a",
      "status": "processing",
      "items": [
        {
          "benefit_type": "health_insurance",
          "levels": [
            {
              "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
              "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
              "cost_sharing": null,
              "coverage_selections": null
            }
          ],
          "ref": null
        }
      ],
      "group_policy_ids": [
        "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
      ],
      "disclosures": [
        {
          "category": "regulatory",
          "type": "intermediary_role",
          "text": "string"
        }
      ],
      "type": null,
      "due_date": "2024-12-01T00:00:00Z",
      "cost_sharing": null,
      "action_required": null,
      "object": "string"
    }
  ],
  "page": 123,
  "page_size": 123,
  "total_count": 123,
  "has_next_page": true,
  "has_previous_page": true
}

Returns a paginated list of group_policy_intent’s. The results are returned sorted by creation date, with the most recent appearing first.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Query parameters

group_idstringOptionalformat: "gr_.+"

Filter by group ID. Matches the intent's own group or any level of the quote intent it accepts.

plan_idstringOptionalformat: "pl_.+"

Filter by plan ID. Matches the intent's own plan or any level of the quote intent it accepts.

typeenumOptional

Filter by shape: single for one group and plan, multi_level for several levels

Allowed values:

statusstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: processing, action_required, pending_provider_approval, policy_created, expired, provider_rejected, manual_renewal_gathering_required.

pageintegerOptional

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

page_sizeintegerOptional

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

Response

itemslist of objects

A paginated array containing the response elements

pageinteger

The current page of the results

page_sizeinteger

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

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_pagebooleanOptionalRead-only

Whether there are more pages available after this page

has_previous_pagebooleanOptionalRead-only

Whether there are more pages available before this page

Authentication

Headers

Query parameters

Response