Skip to main content
This section is a complete, interactive reference for the Fatorly Integration API (v1). Every endpoint is listed in the sidebar under API Reference, with its parameters, request and response schemas, and an in-page playground so you can send live requests and see real responses.
New to the API? Start with the Overview, Authentication, and Quickstart guides, then use this reference for the full endpoint detail.

​
Base URL

All endpoints are versioned under /v1 (for example, POST /v1/invoices). The examples in this reference use production — swap the host for sandbox.

​
Allowed values

Closed-vocabulary fields accept exactly these values (also declared as enums on each endpoint’s schema below, with an example pre-filled in the playground):

​
Authenticate

Every request requires your API key in the X-Api-Key header.
1

Generate an API key

In the platform, go to Settings → API Keys and create a key. It looks like fat_… and is shown only once — copy it immediately. See API Keys.
2

Add it to the playground

In any endpoint page below, open the Authorization panel and paste your key into the X-Api-Key field.
3

Send a request

Fill in the parameters and select Send to call the live Integration API.
Treat your API key like a password. Calls run against your real company data. If a key is lost or compromised, revoke it under Settings → API Keys and create a new one.