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

Retrieve a group policy

GET
/group_policies/:group_policy_id
GET
/group_policies/:group_policy_id
$curl https://test.api.kota.io/group_policies/gp_3b1333d87d9d4fd6ad83ba7f6b0e951a \
>     -H "Authorization: Bearer <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3  "start_date": "2024-12-01",
4  "status": "scheduled",
5  "type": "health_insurance",
6  "provider": {
7    "id": "pr_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
8    "name": "HealthFirst Insurance",
9    "description": "Leading provider of comprehensive health insurance plans.",
10    "logo_url": "https://healthfirst.example.com/logo.png",
11    "employer_portal_url": "https://employer.healthfirst.example.com",
12    "employee_portal_url": "https://employee.healthfirst.example.com",
13    "support_phone_number": "+18005551234"
14  },
15  "plan": {
16    "id": "pl_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
17    "name": "HealthFirst Premium Plan",
18    "description": "Premium health insurance plan with extensive coverage and low deductibles.",
19    "currency": "eur",
20    "documents": [
21      {
22        "title": "Insurance Product Information Document",
23        "link": "https://healthfirst.example.com/docs/ipid-premium.pdf",
24        "type": "ipid"
25      }
26    ]
27  },
28  "group_id": "gr_7f9a2c4d5e6b4a1f8c3d2e7f9a0b1c2d",
29  "employer_id": "er_5d4c3b2a1f8e7d6c9b0a1e2f3d4c5b6a",
30  "end_date": "2025-11-30",
31  "object": "group_policy"
32}

Retrieves a group_policy object.

Previous

List all group policies

Next

List group policy intents

Built with

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

group_policy_idstringRequiredformat: "gp_.+"

Response

OK
idstringformat: "gp_.+"

Unique identifier for the group policy. Prefixed with gp_.

start_datedate

Policy start (effective) date in ISO 8601 (YYYY-MM-DD).

statusenum

Current lifecycle state of the group_policy, indicating its progress from creation to activation. Possible values are:

  • scheduled: Group policy has been scheduled for activation.
  • active: Group policy is now active
  • expired: Group policy is no longer active as it reached its end date
  • cancelled: Group policy is now cancelled for any reason.
Allowed values:
typeenum

Policy type. Determines which sub-object is populated.

Allowed values:
providerobject
Provider information for this policy.
planobject
Plan information for this policy
group_idstringformat: "gr_.+"
Identifier for the group associated with this group policy.
employer_idstringformat: "er_.+"
Identifier for the employer associated with this group policy.
end_datedate or null

Policy end date (inclusive) in ISO 8601 (YYYY-MM-DD), or null if open-ended.

cancellation_datedate or null

Policy cancellation date (inclusive) in ISO 8610 (YYYY-MM-DD), or null if not applicable.

health_insuranceobject

Health insurance–specific fields (present when type=health_insurance).

objectstringRead-only
The object type

Errors

404
Not Found Error