Skip to main content
Every call sends the key in the header. The request carries no email and no organisation id. The organisation and the user come from the key.
The key starts with fyv_api_. A token that starts with fyv_mcp_ or fyv_addin_ is rejected.

Create a key

Only an administrator sees the tab and can create or revoke keys.
  1. In Fyvel, open Company settings → API.
  2. Choose New API key and enter a name, for example BI nightly pull.
  3. Copy the bearer token immediately. It is shown only once.
An administrator can hold up to five active keys. A new key leaves the existing ones valid. Revoke one key when you rotate it. The call runs with that administrator’s access. A company the administrator can see is a company the key can see. The key stops working when that administrator loses the admin role or leaves the organisation.

Errors

Errors are JSON with error and code. Other endpoints use the same shape. Common codes there are INVALID_FILTER, FORBIDDEN, REFRESH_PENDING, and LOAD_FAILED.