List requirements for a group setup intent | Kota Developer Products Documentation

Returns a paginated list of adaptive requirements for a group_setup_intent. Requirements must be fulfilled before policy setup can proceed.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path parameters

groupSetupIntentIdstringRequiredformat: "gsi_.+"

Query parameters

object_typeobjectOptional

Filter by object type (employee or employer)

object_idstringOptional

Filter by object ID (employee ID or employer ID)

pageintegerOptional

The page of results to return. Defaults to 1 if not provided.

page_sizeintegerOptional

The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

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 nullRead-only

Whether there are more pages available after this page

has_previous_pageboolean or nullRead-only

Whether there are more pages available before this page

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

1	{
2	"items": [
3	{
4	"id": "string",
5	"object_type": "employee",
6	"object_id": "string",
7	"is_fulfilled": true,
8	"requirement_type": "string",
9	"object": "string"
10	}
11	],
12	"page": 123,
13	"page_size": 123,
14	"total_count": 123,
15	"has_next_page": true,
16	"has_previous_page": true
17	}

Authentication

Path parameters

Query parameters

Response

Errors