Get started
Authentication
Every request is authenticated with an API key sent as a bearer token.
cURL
curl "https://api.spartivo.com/api/v1/metadata/modules" \
-H "Authorization: Bearer wk_your_key"API keys
Create and delete keys in Setup → Developer space → API keys. Only people whose profile allows the Developer area can manage keys.
- A key starts with
wk_and is shown in full only when it is created. - A key belongs to the user who created it. It can do what that user can do: the same modules, the same fields, the same records. If the user is deactivated, the key stops working.
- To limit what an integration can reach, create a user with a restricted profile and role for it, and create the key as that user.
- Deleting a key takes effect straight away.
When authentication fails
A missing or wrong key returns status 401. A valid key without permission for the action returns 403.
401 Unauthorized
{
"error": "missing bearer token",
"message": "missing bearer token"
}