API Documentation

Welcome to the Integration API. We hope you find it easy and pleasant to use. If you have any feedback or questions, please let us know.

Enter your Tenant and API Key in the top right corner to test endpoints directly.

Multi-tenant

All API routes are prefixed with the tenant name. For example, if your tenant is demo, all your requests go to /demo/api/...

Authentication

All endpoints require authentication. Send your API key in the Authorization header as a Bearer token:

curl -X GET "/{tenant}/api/users" \
  -H "Authorization: Bearer sk_your_api_key"

Dates & Times

All dates are in the tenant's configured timezone, not UTC. This means when you send or receive 10:00, it's 10:00 in the tenant's local time (e.g., Madrid, Buenos Aires). No timezone conversion needed on your side.

Format: RFC3339 with offset, e.g. 2025-11-11T10:00:00+01:00

Money Fields

Money values are integers in cents (smallest currency unit) to avoid floating-point rounding errors.

Example: 1050 = $10.50

Error Handling

Errors return an appropriate HTTP status code with a JSON body containing an error field:

{ "error": "Invalid email format" }

Common status codes: 400 (bad request), 401 (unauthorized), 404 (not found), 500 (server error).

Terms of Service

The API is provided as-is and without any warranty whatsoever. We are not liable for any damage due to unavailable or incorrect APIs.

Whilst we use all reasonable endeavours to correct any errors or omissions as soon as practicable once they have been brought to our attention, we make no promises, guarantees, representations or warranties of any kind whatsoever (express or implied).

Abuse or excessively frequent requests via the API may result in the temporary or permanent suspension of your account's access. We will make a reasonable attempt to warn you via email prior to suspension.

We reserve the right to change these terms at any time.