Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kota groups API

The groups API from Kota — 4 operation(s) for groups.

Kota groups API is one of 33 APIs that Kota publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://test.api.kota.io, https://api.kota.io.

7 operations 4 paths 23 schemas 3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kota.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kota groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authorization header using the Bearer scheme

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

groups 7
GET
/groups
List all groups
list-groups 5 params → 200
POST
/groups
Create a group
create-group 1 param body → 200400404
GET
/groups/{group_id}
Retrieve a group
retrieve-group 2 params → 200404
PUT
/groups/{group_id}
Update a group
update-group 2 params body → 200400404
GET
/groups/{group_id}/employees
List employees in a group
list-group-employees 5 params → 200
POST
/groups/{group_id}/employees
Add an employee to a group
add-employee-to-group 3 params body → 200400404
POST
/groups/{group_id}/eligibility_check
Check employee eligibility for a group
check-group-eligibility 2 params body → 200400404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are GroupResponse (11 properties), GroupEmployeeResponse (10 properties), GroupEmployeeResponsePagedList (6 properties), HttpValidationProblemDetails (6 properties). Each schema is shown below with its type and property counts.

AddEmployeeToGroupRequest
object
3 properties 1 required
EnrolmentStatus
string
GroupType
string
PlanProviderResponse
object
4 properties 4 required
EnrolmentReference
object
1 property 1 required
PolicyReference
object
1 property 1 required
UpdateGroupRequest
object
2 properties
GroupStatus
string
GroupResponse
object
11 properties 9 required
CreateGroupRequest
object
3 properties 2 required
ScheduledGroupTransitionResponse
object
2 properties 2 required
EligibilityCheckResponse
object
5 properties 4 required
GroupEmployeeResponse
object
10 properties 7 required
GroupEmployeeResponsePagedList
object
6 properties 4 required
GroupResponsePagedList
object
6 properties 4 required
ProblemDetails
object
5 properties
EligibilityCheckReasonResponse
object
2 properties 2 required
EligibilityCheckPlanResponse
object
3 properties 3 required
GroupEnrolmentType
string
CheckGroupEligibilityRequest
object
1 property 1 required
HttpValidationProblemDetails
object
6 properties
EligibilityStatus
string
PolicyConfigurationRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-groups-api-openapi.yml Raw ↑

Other APIs Kota publishes across the network.

Kota Associated Persons API
Kota associatedPersons API
Kota Contribution Reports API
Kota contributionReports API
Kota Dependents Management Intents API
Kota dependentsManagementIntents API
Kota Embed Sessions API
Kota embedSessions API
Kota employees API
Kota employers API
Kota Enrolment Intents API
Kota enrolmentIntents API