CRM API
Read and write accounts, contacts, leads and opportunities over HTTP.
The public CRM API lives under /_api/v1/crm. It covers the core objects.
| Resource | Read | Write |
|---|---|---|
| Accounts | yes | yes |
| Contacts | yes | yes |
| Leads | yes | yes, plus convert |
| Opportunities | yes | yes |
| Activities | — | yes |
Steps
- Mint a key.
- Send it as a bearer token.
- Start with a read to confirm auth before writing anything.
- Write one record and check it in the UI before running a batch.
You're done when a record you created over HTTP appears in the CRM.
In-app reference
The app carries a live API Reference page with exact request and response shapes for your workspace. That is the authoritative surface — shapes stated here would drift.
Practical notes
- Check for duplicates on write. The API will happily create a second contact with the same email; the duplicates surface is your safety net, not a preventer.
- Log activities. A record with no history produces poor outreach, whether a human or an agent writes it.
Gotchas
- This is not the whole product over HTTP. Objectives, chat and campaigns are not public API surfaces. If you need to start work externally, use a routine webhook.