Retrieve a group policy intent

GET

/group_policy_intents/:group_policy_intent_id

GET

/group_policy_intents/:group_policy_intent_id

curl https://test.api.kota.io/group_policy_intents/gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a \
     -H "Authorization: Bearer <apiKey>"

{
  "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",
      "links": [
        {
          "token": "string",
          "type": "intermediary_role",
          "label": "string",
          "url": "string",
          "version": "string"
        }
      ]
    }
  ],
  "type": null,
  "due_date": "2024-12-01T00:00:00Z",
  "cost_sharing": null,
  "action_required": null,
  "object": "string"
}

Retrieves a group_policy_intent object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

group_policy_intent_idstringRequiredformat: "gpi_.+"

Response

idstringformat: "gpi_.+"

Unique identifier for the group policy intent

group_idstring or nullformat: "gr_.+"

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

plan_idstring or nullformat: "pl_.+"

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

quote_intent_idstringformat: "gqi_.+"

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

statusenum

Current status of the group policy intent

itemslist of objects

The benefits the accepted quote covers and the levels they were quoted at, echoed from the quote intent. Always present: a single intent echoes its group, plan and cost sharing as one item of one level, so a consumer reads one shape for both.

group_policy_idslist of strings

The group policies created for this intent, one per level, once they exist. Always present and empty until the intent reaches policy_created.

disclosureslist of objects

Disclosures associated with this intent.

typeenumOptional

Whether the accepted quote covers one (group, plan) pair or several levels. Absent or null means single, so readers of intents created before multi-level quoting need no migration. Always the type of the quote intent this policy intent accepts.

Allowed values:

due_datedatetime or nullOptional

Due date for the policy intent

cost_sharingobjectOptional

Cost sharing configuration for the policy intent. Null on a multi-level intent, whose cost sharing is fixed per level at quote time.

action_requiredobjectOptional

Details of the required action when the intent is in ActionRequired status.

objectstringOptionalRead-only

Object type identifier

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors