Retrieve a group policy | Kota Developer Products Documentation

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

{
  "id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "start_date": "2024-12-01",
  "status": "scheduled",
  "type": "health_insurance",
  "provider": {
    "id": "pr_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d",
    "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_1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p",
    "name": "HealthFirst Premium Plan",
    "description": "Premium health insurance plan with extensive coverage and low deductibles.",
    "currency": "eur",
    "documents": [
      {
        "title": "Insurance Product Information Document",
        "link": "https://healthfirst.example.com/docs/ipid-premium.pdf",
        "type": "ipid"
      }
    ]
  },
  "group_id": "gr_7f9a2c4d5e6b4a1f8c3d2e7f9a0b1c2d",
  "employer_id": "er_5d4c3b2a1f8e7d6c9b0a1e2f3d4c5b6a",
  "end_date": "2025-11-30",
  "object": "group_policy"
}

Retrieves a group_policy object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

group_policy_idstringRequiredformat: "gp_.+"

Response

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