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 employees API

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

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

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

This API exposes 6 operations across 4 paths, and defines 14 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.

6 operations 4 paths 14 schemas 2 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 employees API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authorization header using the Bearer scheme

Paths & Operations 6

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

employees 6
GET
/employees
List all employees
list-employees 7 params → 200400
POST
/employees
Create an employee
create-employee 2 params body → 200400
GET
/employees/{employee_id}
Retrieve an employee
retrieve-employee 2 params → 200400404
PUT
/employees/{employee_id}
Update an employee
update-employee 2 params body → 200400404
POST
/employees/{employee_id}/offboard
Offboard an employee
offboard-employee 3 params body → 200400
POST
/employees/{employee_id}/offboard/cancel
Cancel offboarding an employee
cancel-offboarding-employee 3 params → 200400404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are EmployeeResponse (20 properties), CreateEmployeeRequest (15 properties), UpdateEmployeeRequest (11 properties), AddressModel (7 properties). Each schema is shown below with its type and property counts.

AddressModelWithoutCountry
object
6 properties 3 required
EmployeeBankAccount
object
1 property 1 required
EmployeeStatus
string
CountryCode
string
AddressModel
object
7 properties 4 required
SexAtBirth
string
EmployeeResponse
object
20 properties 7 required
UpdateEmployeeRequest
object
11 properties
CreateEmployeeBankAccount
object
1 property 1 required
HttpValidationProblemDetails
object
6 properties
CreateEmployeeRequest
object
15 properties 10 required
ProblemDetails
object
5 properties
EmployeeResponsePagedList
object
6 properties 4 required
OffboardEmployeeRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-employees-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 employers API
Kota Enrolment Intents API
Kota enrolmentIntents API
Kota events API