Developer Documentation
Endpoints
External Records
Base URL: https://app.kinabase.com/api/v1/
get
collections/{collectionId}/ext/{externalService}/{externalId}
Gets a single record from a collection 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 |
| 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}/ext/{externalService}/{externalId}
Updates an existing record in a collection 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 |
| includeFileStorage | query | boolean | Whether to include external file storage folder info (creates the folder if it doesn't exist) |
Request Body
Value to insert
Example request (application/json):
{
"id": null,
"numericId": null,
"createdAt": null,
"updatedAt": null,
"data": {
"example-key": {}
},
"external": null,
"lists": null,
"fileStorage": null,
"stageHistory": null
}delete
collections/{collectionId}/ext/{externalService}/{externalId}
Deletes a single record from a collection 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 |