Developer Documentation
Endpoints
Records
Base URL: https://app.kinabase.com/api/v1/
get
collections/{collectionId}
Gets a paginated list of all records in a collection.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| pageIndex | query | integer | Page index to return, starting at 0 |
| pageSize | query | integer | Number of records to return (default: 10, min: 1, max: 300) |
| updatedAfter | query | string | Only return records updated after this time (ISO8601 format) |
| externalService | query | string | Only fetch records linked to a specified external service (externalService=true for match any service) |
| includeLists | query | boolean | Whether to include lists |
| includeStageHistory | query | boolean | Whether to include each record's workflow stage changes |
Response
| Status | Description | Content |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | |
| 401 | Unauthorized | |
| 404 | Not Found |
post
collections/{collectionId}
Adds a new record to a collection.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| includeFileStorage | query | boolean | Whether to include external file storage folder info (creates the folder if it doesn't exist) |
Request Body
Record Json
Example request (application/json):
{
"id": null,
"numericId": null,
"createdAt": null,
"updatedAt": null,
"data": {
"example-key": {}
},
"external": null,
"lists": null,
"fileStorage": null,
"stageHistory": null
}get
collections/{collectionId}/all
Gets a chunked response of all the records in a collection.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| updatedAfter | query | string | Only return records updated after this time (ISO8601 format) |
| externalService | query | string | Only fetch records linked to a specified external service (externalService=true for match any service) |
| includeStageHistory | query | boolean | Whether to include each record's workflow stage changes |
get
collections/{collectionId}/{recordId}
Gets a single record from a collection.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| recordId * | path | string | Record ID |
| includeLists | query | boolean | Whether to include lists |
| includeFileStorage | query | boolean | Whether to include external file storage folder info |
| includeStageHistory | query | boolean | Whether to include the record's workflow stage changes |
patch
collections/{collectionId}/{recordId}
Updates an existing record in a collection.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| recordId * | path | string | Record ID to update |
| includeFileStorage | query | boolean | Whether to include external file storage folder info (creates the folder if it doesn't exist) |
Request Body
Record JSON
Example request (application/json):
{
"id": null,
"numericId": null,
"createdAt": null,
"updatedAt": null,
"data": {
"example-key": {}
},
"external": null,
"lists": null,
"fileStorage": null,
"stageHistory": null
}delete
patch
collections/{collectionId}/{recordId}/stage
Changes a record stage.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| recordId * | path | string | Record ID to update |
Request Body
Object containing StageId and optional manual additional signatures
Example request (application/json):
{
"stageId": "example-stageId",
"additionalSignatures": null
}patch
collections/{collectionId}/ext/{externalService}/{externalId}/stage
Changes a record stage by external service ID.Parameters
| Name | Location | Type | Description |
|---|---|---|---|
| collectionId * | path | string | Collection ID or Slug |
| externalService * | path | string | External service name |
| externalId * | path | string | External service ID |
Request Body
Object containing StageId and optional manual additional signatures
Example request (application/json):
{
"stageId": "example-stageId",
"additionalSignatures": null
}