Create API keys

The API can read and change inventory, and read valuations, consignments and invoices. Read the API documentation for the endpoints and examples.

API access is part of the Business and Enterprise plans. On another plan, API keys shows "Not on your plan". Owners and admins can click "Change your plan".

Only owners and admins can create and revoke keys.

Create a key

1. Go to API keys.
2. Click "Create key".
3. Type a "Name", such as "Accounting sync".
4. In "Access", choose "Read and write" or "Read only".
5. In "Expires", choose "Never" or a number of days: 30, 90, 365.
6. Click "Create key".
7. Copy the key and store it in your password manager or secrets store. This is the only time the app shows the key.
8. Click "Done".

The key acts as you, in this workspace. Anyone with the key can read and change your inventory. Use "Read only" when a system only reads data.

See your keys

The "Keys" list shows each key with its name, the first characters of the key, and "Read only" for a read-only key. It also shows when the key was created, when it was last used, and when it expires.

Revoke a key

1. Click "Revoke" on the key.
2. Click "Revoke key".

Anything that uses the key stops working. Requests with a revoked or expired key are refused at once. You cannot undo this.