Retrieve a group | Kota Embed Documentation

Retrieves a group object.

Authentication

AuthorizationBearer

Authorization header using the Bearer scheme

Path Parameters

group_idstringRequiredformat: "gr_.+"

Response

idstringformat: "gr_.+"

Unique identifier for the group. Prefixed with gr_.

namestring

Human-readable name of the group.

statusenum

Current lifecycle state of the group, indicating its current progress. Possible values are:

pending: Group is being configured, may require a quote_intent or a setup_intent to be ready.
ready: Setup is complete, regardless of policy start dates employees could start enrolling into policies.
archived: Archived as the group is no longer active or in use for any reason. Employees can no longer be added to the group.

Current lifecycle state of the `group`, indicating its current progress. Possible values are: - `pending`: Group is being configured, may require a `quote_intent` or a `setup_intent` to be ready. - `ready`: Setup is complete, regardless of policy start dates employees could start enrolling into policies. - `archived`: Archived as the group is no longer active or in use for any reason. Employees can no longer be added to the group.

Allowed values:

group_typeenum

Indicates how policies are organized for this group.

single: exactly one policy is associated to the group.
bundled: multiple policies are bundled under the group.
undefined: type not yet determined or not applicable.

Indicates how policies are organized for this group. - `single`: exactly one policy is associated to the group. - `bundled`: multiple policies are bundled under the group. - `undefined`: type not yet determined or not applicable.

Allowed values:

employer_idstringformat: "er_.+"

Identifier for the employer that owns this group. Prefixed with er_.

group_policy_idslist of strings

Group policy unique identifiers associated with this group.

descriptionstring or null

Short description of the purpose or scope of the group.

objectstring or null

The object type

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

1	{
2	"id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
3	"name": "string",
4	"status": "pending",
5	"group_type": "undefined",
6	"employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
7	"group_policy_ids": [
8	"gp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
9	],
10	"description": "string",
11	"object": "string"
12	}

Authentication

Path Parameters

Response

Errors