Getting started

Requests & responses

Common request headers, response envelopes, IDs and API limits.

Headers

Send the access token with every request. Requests containing JSON must also identify their content type.

http

Authorization: bearer YourTokenHere
Content-Type: application/json

A single-record response wraps the record in data:

json

{
  "data": {
    "id": 123,
    "url": "..."
  }
}

List responses return an array plus paging information:

json

{
  "data": [],
  "totalRecords": 642,
  "nextPage": 2
}

Each access token can make up to 600 API calls per hour. Monitor usage through the X-Celoxis-Api-Usage response header.

Batch create or update requests where practical and cache frequently used records such as users.

Record IDs are numeric and use the property name id. You can retrieve up to 10 records by ID in one request.