List employees in a group | Kota Embed Documentation

Returns a list of employees in a group with their policies and enrolments. The employees are returned sorted by addition date, with the most recently added employees appearing first.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path Parameters

group_idstringRequiredformat: "gr_.+"

Query Parameters

employee_idstringOptionalformat: "ee_.+"

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_pageboolean or null

Whether there are more pages available after this page

has_previous_pageboolean or null

Whether there are more pages available before this page

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

1	{
2	"items": [
3	{
4	"id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"policies": [
6	{
7	"id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a"
8	}
9	],
10	"enrolments": [
11	{
12	"id": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a"
13	}
14	],
15	"desired_policy_start_date": "2024-12-01"
16	}
17	],
18	"page": 123,
19	"page_size": 123,
20	"total_count": 123,
21	"has_next_page": true,
22	"has_previous_page": true
23	}