For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get access
Getting Started Key Concepts Integration Types Core Components Embed Hosted API API Reference
  • API Reference
    • Contribution Reports
    • Events and Webhooks
      • GETList all group policies
      • GETRetrieve a group policy
    • API Errors
Get access
LogoLogo
API ReferenceGroup Policies

List all group policies

GET
/group_policies
GET
/group_policies
$curl https://test.api.kota.io/group_policies \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "items": [
3    {
4      "id": "gp_9f8b7c6d5e4a3b2c1d0e9f8a7b6c5d4e",
5      "start_date": "2024-11-01",
6      "status": "active",
7      "type": "health_insurance",
8      "provider": {
9        "id": "pr_4d3c2b1a0f9e8d7c6b5a4e3f2d1c0b9a",
10        "name": "HealthFirst Insurance",
11        "description": "Leading provider of comprehensive health insurance plans.",
12        "logo_url": "https://healthfirst.example.com/logo.png",
13        "employer_portal_url": "https://employer.healthfirst.example.com",
14        "employee_portal_url": "https://employee.healthfirst.example.com",
15        "support_phone_number": "+18005551234"
16      },
17      "plan": {
18        "id": "pl_7e6d5c4b3a291817161514131211100f",
19        "name": "Premium Health Plan",
20        "description": "Full coverage health insurance plan with extensive benefits.",
21        "currency": "eur",
22        "documents": [
23          {
24            "title": "Insurance Product Information Document",
25            "link": "https://healthfirst.example.com/docs/ipid.pdf",
26            "type": "ipid"
27          }
28        ]
29      },
30      "group_id": "gr_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
31      "employer_id": "er_0f1e2d3c4b5a69788796a5b4c3d2e1f0",
32      "end_date": "2025-10-31",
33      "object": "group_policy"
34    }
35  ],
36  "page": 1,
37  "page_size": 10,
38  "total_count": 25,
39  "has_next_page": true,
40  "has_previous_page": false
41}

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.

Previous

Replay an event

Next

Retrieve a group policy

Built with

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

OK
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_pagebooleanRead-only
Whether there are more pages available after this page
has_previous_pagebooleanRead-only
Whether there are more pages available before this page