List all policy import intents | Kota Developer Products Documentation

Returns a paginated list of policy import intents. The intents are returned sorted by creation date, with the most recent intent appearing first. Results can be filtered by employee ID, group ID, and status.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Query parameters

employee_idstringOptionalformat: "ee_.+"

Filters policy import intents by employee ID. Prefixed with ee_.

group_idstringOptionalformat: "gr_.+"

Filters policy import intents by group ID. Prefixed with g_.

statusstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: processing, failed, success.

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/policy_import_intents"
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": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a",
5	"status": "processing",
6	"employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
7	"group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
8	"provider_policy_number": "string",
9	"member_number": "string",
10	"policy_start_date": "2024-12-01",
11	"associated_persons": [
12	{
13	"id": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a",
14	"associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a",
15	"member_number": null,
16	"start_date": "2024-12-01",
17	"end_date": "2024-12-01"
18	}
19	],
20	"object": "string",
21	"policy_end_date": "2024-12-01"
22	}
23	],
24	"page": 123,
25	"page_size": 123,
26	"total_count": 123,
27	"has_next_page": true,
28	"has_previous_page": true
29	}

Authentication

Query parameters

Response

Errors