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

The employers API from Kota — 3 operation(s) for employers.

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

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

This API exposes 5 operations across 3 paths, and defines 11 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.

5 operations 3 paths 11 schemas 2 GET2 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 employers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — Authorization header using the Bearer scheme

Paths & Operations 5

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

employers 5
GET
/employers
List all employers
list-employers 4 params → 200400404
POST
/employers
Create an employer
create-employer 2 params body → 200400
GET
/employers/{employer_id}
Retrieve an employer
retrieve-employer 2 params → 200404
PUT
/employers/{employer_id}
Update an employer
update-employer 2 params body → 200400404
POST
/employers/{employer_id}/offboard
Offboard an employer
offboard-employer 3 params → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EmployerResponse (11 properties), AddressModel (7 properties), UpdateEmployerRequest (6 properties), AddressModelWithoutCountry (6 properties). Each schema is shown below with its type and property counts.

AddressModelWithoutCountry
object
6 properties 3 required
CountryCode
string
AddressModel
object
7 properties 4 required
EmployerStatus
string
CreateEmployerRequest
object
6 properties 3 required
HttpValidationProblemDetails
object
6 properties
UpdateEmployerRequest
object
6 properties
EmployerResponse
object
11 properties 4 required
EmployerResponsePagedList
object
6 properties 4 required
ProblemDetails
object
5 properties
ContactModel
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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