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

The associatedPersons API from Kota — 2 operation(s) for associatedpersons.

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

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

This API exposes 5 operations across 2 paths, and defines 8 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 2 paths 8 schemas 1 DELETE2 GET1 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 associatedPersons 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

associatedPersons 5
GET
/employees/{employee_id}/associated_persons
List associated persons
list-associated-persons 4 params → 200404
POST
/employees/{employee_id}/associated_persons
Create an associated person
create-associated-person 2 params body → 200400404
GET
/employees/{employee_id}/associated_persons/{associated_person_id}
Retrieve an associated person
retrieve-associated-person 3 params → 200404
PUT
/employees/{employee_id}/associated_persons/{associated_person_id}
Update an associated person
update-associated-person 3 params body → 200400404
DELETE
/employees/{employee_id}/associated_persons/{associated_person_id}
Delete an associated person
delete-associated-person 3 params → 200404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AssociatedPersonResponse (11 properties), UpdateAssociatedPersonRequest (7 properties), CreateAssociatedPersonRequest (7 properties), HttpValidationProblemDetails (6 properties). Each schema is shown below with its type and property counts.

RelationshipType
string
UpdateAssociatedPersonRequest
object
7 properties
SexAtBirth
string
CreateAssociatedPersonRequest
object
7 properties 5 required
AssociatedPersonResponse
object
11 properties 7 required
AssociatedPersonResponsePagedList
object
6 properties 4 required
HttpValidationProblemDetails
object
6 properties
ProblemDetails
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kota-associatedpersons-api-openapi.yml Raw ↑

Other APIs Kota publishes across the network.

Kota Associated Persons 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
Kota events API