The REST API gives programmatic access to your company’s data. It is for developers building an integration; you do not need it for everyday use.
- API reference: the full reference is public at /docs/api on your workspace address, with the OpenAPI document at /docs/api/openapi.yaml and /docs/api/openapi.json. API & webhooks in Settings links to it.
- Base URL: shown at the top of API & webhooks. It ends in /api/v1.
- Authentication: send the header Authorization: Bearer followed by your token, and Accept: application/json.
- Responses: JSON only. Single records are wrapped in data; lists add meta and links for cursor pagination (limit and cursor parameters, up to 100 per page).
- Safe retries: send an Idempotency-Key header on POST requests. Repeating the same request with the same key returns the stored response instead of creating a second record. Keys are kept for 24 hours.
- Rate limit: 120 requests per minute per token. The X-RateLimit-Limit and X-RateLimit-Remaining headers show where you are; over the limit you get 429 with a Retry-After header.
What a request can do
A call succeeds only when the token has the ability (for example invoices:write) and the token’s user has the matching permission in the app. The same business rules apply as on screen, so an issued invoice cannot be edited through the API either.
Related guides
Ask about the product
Ask what the software can do, how a task works, or which countries and languages it supports. Answers come from these guides.
Thinking…
The AI assistant is not available right now. Search the guides or talk to our team. Contact support
AI can make mistakes. Check the linked guides.
Still need help?
Our support team reads every message and answers in plain language.
Contact support