List all enrolment intents | Kota Developer Products Documentation

curl https://test.api.kota.io/enrolment_intents \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json"

{
  "items": [
    {
      "id": "ei_9f8b7c6d5a4e3f2b1c0d9e8f7a6b5c4d",
      "employee_id": "ee_1a2b3c4d5e6f7g8h9i0jklmnopqrstuv",
      "group_id": "gr_4d3c2b1a0f9e8d7c6b5a4e3f2d1c0b9a",
      "status": "processing",
      "force_confirmation": true,
      "policy_enrolments": [
        {
          "type": "health_insurance",
          "estimated_effective_from": "2024-12-01",
          "provider": {
            "id": "pr_7e6f5d4c3b2a1908f7e6d5c4b3a29108",
            "name": "Acme Health Providers",
            "description": "Leading provider of comprehensive health insurance plans.",
            "logo_url": "https://acmehealth.com/assets/logo.png",
            "employer_portal_url": null,
            "employee_portal_url": null,
            "support_phone_number": null
          },
          "plan": {
            "id": "pl_0a1b2c3d4e5f6789abcdef0123456789",
            "name": "Premium Health Plan",
            "description": "Full coverage health insurance with dental and vision benefits.",
            "currency": "eur",
            "documents": [
              {
                "title": "Insurance Product Information Document",
                "link": "https://acmehealth.com/docs/premium-plan-ipid.pdf",
                "type": "ipid"
              }
            ]
          },
          "health_insurance": null,
          "id": "p_1234567890abcdef1234567890abcdef"
        }
      ],
      "object": "enrolment_intent",
      "ineligibility_reason": null,
      "policy_configuration": null,
      "action_required": null,
      "pending_confirmation": null
    }
  ],
  "page": 1,
  "page_size": 10,
  "total_count": 25,
  "has_next_page": true,
  "has_previous_page": false
}

Returns a list of enrolment_intents. The enrolment_intents are returned sorted by creation date, with the most recent enrolment_intent appearing first.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Query parameters

employee_idstringOptionalformat: "ee_.+"

Filters enrolment intents by employee.

group_idstringOptionalformat: "gr_.+"

Filters enrolment intents by group.

statusstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: processing, scheduled, action_required, pending_confirmation, enrolling, enrolled, not_undertaken, ineligible.

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_pageboolean or nullRead-only

Whether there are more pages available after this page

has_previous_pageboolean or nullRead-only

Whether there are more pages available before this page

Authentication

Query parameters

Response

Errors