List all employee policies

GET

/employees/:employee_id/health_insurance/policies

Returns a list of group health insurance policies for an employee. The policies are returned sorted by creation date, with the most recent policy appearing first.

Path parameters

employee_idstringRequired

Query parameters

statusstringOptional

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

pageintegerOptional

page_sizeintegerOptional

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_pagebooleanOptional

Whether there are more pages available after this page

has_previous_pagebooleanOptional

Whether there are more pages available before this page

GET

1 curl https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies \
2      -H "Authorization: Bearer <apiKey>"

200Retrieved

1 {
2   "items": [
3     {
4       "id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5       "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
6       "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
7       "start_date": "2024-12-01",
8       "end_date": "2024-12-01",
9       "status": "scheduled",
10       "enrolment_type": "opt_out",
11       "renewal": {
12         "status": "upcoming",
13         "renewal_date": "2024-12-01",
14         "window_start_date": "2024-12-01",
15         "window_end_date": "2024-12-01",
16         "decision_confirmed": true
17       },
18       "opt_out_deadline_date": "2024-12-01",
19       "coverage_level": {
20         "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
21         "plan_name": "plan_name",
22         "plan_currency": "eur",
23         "provider_name": "provider_name",
24         "provider_logo_url": "provider_logo_url",
25         "documents": [
26           {
27             "title": "title",
28             "link": "link"
29           }
30         ]
31       },
32       "object": "object",
33       "external_customer_id": "external_customer_id",
34       "cancellation_date": "2024-12-01",
35       "policy_number": "policy_number"
36     }
37   ],
38   "page": 1,
39   "page_size": 1,
40   "total_count": 1,
41   "has_next_page": true,
42   "has_previous_page": true
43 }

Built with

1	curl https://test.api.kota.io/employees/ee_3b1333d87d9d4fd6ad83ba7f6b0e951a/health_insurance/policies \
2	-H "Authorization: Bearer <apiKey>"

1	{
2	"items": [
3	{
4	"id": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
6	"employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
7	"start_date": "2024-12-01",
8	"end_date": "2024-12-01",
9	"status": "scheduled",
10	"enrolment_type": "opt_out",
11	"renewal": {
12	"status": "upcoming",
13	"renewal_date": "2024-12-01",
14	"window_start_date": "2024-12-01",
15	"window_end_date": "2024-12-01",
16	"decision_confirmed": true
17	},
18	"opt_out_deadline_date": "2024-12-01",
19	"coverage_level": {
20	"plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a",
21	"plan_name": "plan_name",
22	"plan_currency": "eur",
23	"provider_name": "provider_name",
24	"provider_logo_url": "provider_logo_url",
25	"documents": [
26	{
27	"title": "title",
28	"link": "link"
29	}
30	]
31	},
32	"object": "object",
33	"external_customer_id": "external_customer_id",
34	"cancellation_date": "2024-12-01",
35	"policy_number": "policy_number"
36	}
37	],
38	"page": 1,
39	"page_size": 1,
40	"total_count": 1,
41	"has_next_page": true,
42	"has_previous_page": true
43	}