Overview
Every endpoint of the Tillor HTTP API, with parameters, example requests and a playground.
Last updated on
This reference is generated directly from the Tillor API. Each endpoint has its own page with parameters, request body, possible responses and code examples. In the sidebar the endpoints are grouped by topic.
Sending a request
Every request needs your API key in the x-api-key header. Endpoints under /orgs/{organizationId} work within one organisation.
GET https://api.tillor.eu/orgs/org_abc123/customers
x-api-key: tkn_xxxYou create an API key in the app, under your account. How that works, which rate limits apply and how to keep keys safe is explained in HTTP API.
Who may call an endpoint
Every endpoint page shows at the top, under Access, who may call the endpoint. For most endpoints that is a member of the organization with a given permission, such as customers:read. An API key works with the permissions of the person who created it; if the key has scopes, the permission must be among them too. Otherwise the API answers 403.
The specification carries the same information per endpoint in x-tillor-access, with access (who) and permissions (one of them is enough).
Trying it out in the playground
On every endpoint page you can send the request straight away. If you are signed in to Tillor in the same browser, the playground uses your session and you do not need an API key. Otherwise, enter your API key under Authorization. Adjust the parameters and click Send.
The playground talks to the real API of your organisation: a POST, PUT or DELETE therefore changes real data.
Use a test organisation
Try out endpoints that write data on a test organisation, not on your live park.
Downloading the specification
The full specification is available as OpenAPI 3.1 at tillor.eu/api/openapi.json. Import it into Postman or Insomnia, or generate a client from it.