List all group policies | Kota Developer Products Documentation

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

{
  "items": [
    {
      "id": "gp_9f8b7c6d5e4a3b2c1d0e9f8a7b6c5d4e",
      "start_date": "2024-11-01",
      "status": "active",
      "type": "health_insurance",
      "provider": {
        "id": "pr_4d3c2b1a0f9e8d7c6b5a4f3e2d1c0b9a",
        "name": "HealthFirst Insurance",
        "description": "Leading provider of comprehensive health insurance plans.",
        "logo_url": "https://healthfirst.example.com/logo.png",
        "employer_portal_url": "https://employer.healthfirst.example.com",
        "employee_portal_url": "https://employee.healthfirst.example.com",
        "support_phone_number": "+18005551234"
      },
      "plan": {
        "id": "pl_7e6d5c4b3a291817161514131211100f",
        "name": "Premium Health Plan",
        "description": "Full coverage health insurance plan with extensive benefits.",
        "currency": "eur",
        "documents": [
          {
            "title": "Insurance Product Information Document",
            "link": "https://healthfirst.example.com/docs/ipid-premium.pdf",
            "type": "ipid"
          }
        ]
      },
      "group_id": "gr_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
      "employer_id": "er_0f1e2d3c4b5a69788796a5b4c3d2e1f0",
      "end_date": "2025-10-31",
      "cancellation_date": null,
      "health_insurance": null,
      "object": "group_policy"
    }
  ],
  "page": 1,
  "page_size": 10,
  "total_count": 25,
  "has_next_page": true,
  "has_previous_page": false
}

Returns a list of group_policies. By default, only active and scheduled group policies are returned. Use the status query parameter to filter by other statuses. The group_policies are returned sorted by creation date, with the most recent group_policy appearing first.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Query parameters

employer_idstringOptionalformat: "er_.+"

Filters group policies by employer.

group_idstringOptionalformat: "gr_.+"

Filters group policies by group.

statusstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: scheduled, active, expired, cancelled.

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