Information
- OpenAPI version:
3.1.0
Overview
Sonora API v1
Section titled “Sonora API v1”Read and act on your Sonora workspace from your own systems. Every request carries an API key from Settings → API as a bearer token; the key names the workspace.
/v1 only grows: responses may gain fields, and enums and error codes may gain values. Ignore unknown fields, handle unknown values, and fall back on the HTTP status for an unknown code.
A key carries scopes, and each endpoint names the one it needs:
customers:read: Read customers, their custom fields, account teams, health, eCSAT and enrichmentscontacts:read: Read the people at your customersissues:read: Read customer issues, their sources and quotesfeature-requests:read: Read customer feature requests, their sources and quotesmeetings:read: Read customer meetings, their attendees and summariesnotes:read: Read the notes your team shares on customerscustomers:write: Create customers, change their fields (taking them over from CRM sync) and their account teamscustomers:archive: Archive and unarchive customers, with their contactsnotes:write: Add shared notes to customers, and change or delete the notes written through the APIcontacts:write: Mark people do not contact, so Sonora stops emailing them, and lift the markissues:write: Resolve and reopen issues no support ticket backsenrichments:manage: Create, edit and delete enrichments, and run them on customers — runs spend your workspace’s credits. An enrichment’s prompt sees the whole customer, as in Sonora, so grant it as you would the permissioncustom-fields:manage: Create, rename and delete customers’ custom fields and add select options; deleting a field erases its valuesworkflows:trigger: Start API-triggered workflowsworkflows:read: Read workflows, runs and contact roles
Authentication
Section titled “Authentication”apiKey
Section titled “apiKey”An API key from Settings → API: Authorization: Bearer sonora_sk_….
Security scheme type: http
An OAuth access token for the person signed in, read-only: Authorization: Bearer sonora_at_…. It reads the workspace they choose at consent, with the read scopes it was granted that their role in Sonora covers. Today Sonora’s own API docs are the only client offered these scopes; their Try it panel signs in with it.
Security scheme type: oauth2
Flow type: authorizationCode
Authorization URL: https://app.usesonora.com/oauth/authorize
Token URL: https://app.usesonora.com/oauth/token
Scopes:
- customers:read - Read customers, their custom fields, account teams, health, eCSAT and enrichments
- contacts:read - Read the people at your customers
- issues:read - Read customer issues, their sources and quotes
- feature-requests:read - Read customer feature requests, their sources and quotes
- meetings:read - Read customer meetings, their attendees and summaries
- notes:read - Read the notes your team shares on customers
- workflows:read - Read workflows, runs and contact roles