Kinabase Logo
Developer Documentation
Kinabase API

Endpoints

Base URL: https://app.kinabase.com/api/v1/

API Info

get

version

Provides the version of the API.

Auth

post

token

Generates a JWT token for the provided AppId and Secret.
get

status

Get the current API user auth status.

Collections

get

collections

Gets a list of all collections in the database.

Records

get

collections/{collectionId}

Gets a paginated list of all records in a collection.
post

collections/{collectionId}

Adds a new record to a collection.
get

collections/{collectionId}/all

Gets a chunked response of all the records in a collection.
get

collections/{collectionId}/{recordId}

Gets a single record from a collection.
patch

collections/{collectionId}/{recordId}

Updates an existing record in a collection.
delete

collections/{collectionId}/{recordId}

Deletes a single record from a collection.
patch

collections/{collectionId}/{recordId}/stage

Changes a record stage

Bulk Records

post

collections/{collectionId}/bulk

Bulk add new records to collection.
patch

collections/{collectionId}/bulk

Updates existing records in a collection by their recordIds
delete

collections/{collectionId}/bulk

Delete multiple records from a collection.

External Records

get

collections/{collectionId}/ext/{externalService}/{externalId}

Gets a single record from a collection by external service ID.
patch

collections/{collectionId}/ext/{externalService}/{externalId}

Updates an existing record in a collection by external service ID.
delete

collections/{collectionId}/ext/{externalService}/{externalId}

Deletes a single record from a collection by external service ID.

Files

get

files/{id}

Downloads a file by id

Activities

get

activities/{collectionId}/{recordId}

Gets activities by collection and record IDs
post

activities/{collectionId}/{recordId}

Adds a new activity

Colleagues

get

colleagues

Gets a list of colleagues in your Kinabase tenant
get

roles

Gets a list of roles in your Kinabase tenant