Host / URL

The URL for API requests depends on your system's base domain and is composed as follows:


Note: The HTTP Host of your API URL is the same as in your login URL.

All requests must be made over HTTPS. HTTP is not supported


Every API request you make must be authenticated by including an Authorization Header with your API Key. You can find your systems API Key in your Account Settings.

Example header:

POST https://your-api-domain-HERE.tdl
Authorization: Bearer Your.API.Key-HERE

Example with cURL:

curl -X "POST" "https://your-api-domain-HERE.tdl" -H "Authorization: Bearer Your.API.Key-HERE" -H "Content-Type: application/json" 

HTTP Verbs

Depending on the resource, we support the following HTTP verbs:

Verb Description
GET Retrieve a resource or group of resouces
POST Create a new resource 
PUT Update an existing resource
DELETE Delete an existing resource 

Request Body

When submitting data via POST or PUT requests, you must submit your payload in JSON format.

Example request:

POST https://you-api-domain-HERE.tdl HTTP/1.1
Content-Type: application/json
  "mail": "",
  "first_name" : "John",
  "family_name" : "Doe",


Some GET resources allow for retrieval of information in batches. We will provide the query args in the resource documentation when available.

When requesting multiple items, we will default the request limit to 500 items. You can specify a different limit but cannot not exceed the default limit.

Example request:

GET https://<system_id>.<server_id> HTTP/1.1
Parameter Description
limit The number of records to return
offset The number of records to skip