Anything you can do in Tormano you can do through the REST API.
Creating an API key
Go to Settings > Integrations > API Keys and click + New API Key. Give it a name, such as Production Zapier integration, check the permissions it should carry, optionally set an expiry in days, and save.
A key carries three permissions, and they apply on top of your own role:
- read for GET requests
- write for POST and PATCH requests
- delete for DELETE requests
Keys inherit the modules your role can already reach. Leave the expiry blank for a key that never expires.
The key is shown once. Copy it before you close the dialog: it cannot be retrieved later. If you lose one, delete it and create another.
Using the key
Pass it as a Bearer token in the Authorization header. Every Tormano key starts with the brvk_ prefix:
Authorization: Bearer brvk_abc123...
The base path is /api/v1 on your own host: https://crm.tormano.com/api/v1/ or https://npcrm.tormano.com/api/v1/.
Common requests
GET /api/v1/contacts: list contacts, a page at a time.POST /api/v1/contacts: create a contact.GET /api/v1/contacts/[id]: fetch one.PATCH /api/v1/contacts/[id]: update.DELETE /api/v1/contacts/[id]: delete, recoverably.
Same pattern for companies, deals, donations, grants, volunteers, events, activities, custom-fields, and more.
Rate limits
API keys are limited to 100 requests a minute. Going over returns a 429 response, with headers telling you when the limit resets.
Audit trail
Every API call is written to the audit trail, recorded against the key that made it. Deleting a key stops it working; the history it created stays.
When to use webhooks instead
If you need to know the moment something happens, subscribe to webhooks rather than polling the API. See Send your data to another system.