Get started
API keys
One key reads one workspace. Keep it secret, and revoke it when you are done with it.
Create a key
- Open Settings › API keys in the app and create a key with a name you will recognize.
- Only a workspace owner can create or revoke keys.
- The key starts with ftx_ and is shown once. Copy it then; it cannot be shown again.
What a key reads
A key reads only the workspace it was created in. When you create it, you choose what it can read and which books.
- Ledger: accounts, journal entries and journal lines, rules, reconciliations and locked periods.
- Bank transactions: every bank and card transaction, and the ones that still need review.
- Reports: the trial balance, income statement and balance sheet for any period, and the dashboard's key figures and monthly trend.
- Books: every book, including ones added later, or only the books you choose.
Listing entities works with any key and shows only the books the key can read. A read the key was not given answers 403 with "This key cannot read …". A book the key does not reach answers 404, the same as an entity from another workspace or an id that does not exist.
Rotating a key
Rotate a key under Settings › API keys to replace it without an outage. The new key keeps the same name, reads and books, and is shown once. The old key keeps working for the overlap you choose (none, 1 hour, 24 hours or 7 days), then answers 401. A key can be rotated once; revoking the old key during its overlap stops it at once.
Using and revoking a key
Send the key as a bearer token on every request:
Authorization: Bearer ftx_YOUR_KEYRevoke a key under Settings › API keys. The next request with it answers 401. Treat a key like a password: never put it in a browser, a public repository or a shared document.