Retrieve a group policy | Kota Embed Documentation

1 import requests 2 3 url = "https://test.api.kota.io/group_policies/gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" 4 5 headers = {"Authorization": "Bearer <token>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

1 { 2 "id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a", 3 "start_date": "2024-12-01", 4 "status": "scheduled", 5 "type": "health_insurance", 6 "provider": { 7 "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a", 8 "name": "string", 9 "description": "string", 10 "logo_url": "string", 11 "employer_portal_url": "string", 12 "employee_portal_url": "string", 13 "support_phone_number": "string" 14 }, 15 "plan": { 16 "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a", 17 "name": "string", 18 "description": "string", 19 "currency": "eur", 20 "documents": [ 21 { 22 "title": "string", 23 "link": "string", 24 "type": "ipid" 25 } 26 ] 27 }, 28 "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a", 29 "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a", 30 "end_date": "2024-12-01", 31 "cancellation_date": "2024-12-01", 32 "health_insurance": { 33 "renewal": { 34 "renewal_date": "2024-12-01", 35 "window_start_date": "2024-12-01", 36 "window_end_date": "2024-12-01", 37 "status": "upcoming", 38 "renewed_policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" 39 }, 40 "configuration": { 41 "cost_sharing": { 42 "type": "member_count", 43 "member_count": { 44 "adults": 123, 45 "children": 123 46 }, 47 "member_selection": { 48 "partner": true, 49 "children": true 50 }, 51 "percentage": { 52 "percentage": 123 53 } 54 } 55 }, 56 "group_policy_number": "string" 57 }, 58 "object": "string" 59 }

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_datestringformat: "date"

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.

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_idstring or nullformat: "gr_.+"

Identifier for the group associated with this group policy.

employer_idstring or nullformat: "er_.+"

Identifier for the employer associated with this group policy.

end_datestring or nullformat: "date"

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

cancellation_datestring or nullformat: "date"

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

health_insuranceobject or null

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

objectstring or null

The object type

Authentication

Path Parameters

Response

Errors