Developer

API Reference

1. API Info

GET/api/v1/version

Provides the version of the API.

2. Auth

POST/api/v1/token

Generates a JWT token for the provided AppId and Secret.

Tokens can be used by passing a "Authorization" header with a value using a "Bearer {token}" format alongside your request. Note that tokens are valid for 1 hour.

GET/api/v1/status

Get the current API user auth status.

This endpoint is used to check if the token is valid and to get the current user's identity. Please ensure you pass a "Authorization" header with a value using a "Bearer {token}" format.

3. Collections

GET/api/v1/collections

Gets a list of all collections in the database.

GET/api/v1/collections/{collectionId}

Gets a list of all records in a collection.

POST/api/v1/collections/{collectionId}

Adds a new record to a collection.

GET/api/v1/collections/{collectionId}/ext/{externalService}

Gets a list of all records in a collection by external service name.

GET/api/v1/collections/{collectionId}/{recordId}

Gets a single record from a collection.

PATCH/api/v1/collections/{collectionId}/{recordId}

Updates an existing record in a collection.

DELETE/api/v1/collections/{collectionId}/{recordId}

Deletes a single record from a collection.

GET/api/v1/collections/{collectionId}/ext/{externalService}/{serviceId}

Gets a single record from a collection by external serviceID.

POST/api/v1/collections/{collectionId}/ext/{externalService}/{serviceId}

Adds a new record to a collection with external service ID.

PATCH/api/v1/collections/{collectionId}/ext/{externalService}/{serviceId}

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

4. Files

GET/api/v1/files/{id}

Downloads a file by id

POST/api/v1/files

Uploads a file,

To upload a file, make sure you are using the form-data content type. Add a key-value pair with “file” and the value being the file you want to upload.

5. Activities

POST/api/v1/{collectionId}/{recordId}/activities

Adds a new activity

6. Colleagues

GET/api/v1/colleagues

Gets a list of colleagues in the organisation