Developers

Keys and scopes

A key acts as one teammate, limited to the areas you tick and to what that teammate can already reach.

A key acts as a teammate

  • Every request runs as the key's teammate. It sees the leads and records they see, and nothing more.
  • What it does shows that teammate with the key's name, such as “Jordan via Zapier”.
  • Do-not-contact tags, opt-outs and calling hours always apply. A key can't switch them off (see Compliance).
  • An account can have 25 live keys. Key names are up to 60 characters.

Levels

LevelWhat it allows
readSee records. Every key gets read on each area it has any level for.
writeCreate and change records.
sendReach a person outside the CRM: place a call, send a text or an email.
deleteRemove records. Only the account owner can grant it. No endpoint uses it yet.
adminReserved. It can't be granted yet.

Scopes by area

A scope is an area and a level, written area:level, such as leads:write. Each endpoint lists the scopes it needs, and a key missing one gets a 403 that names them.

Areareadwritesenddeleteadmin
leads
Leads
Yes
16 endpoints
Yes
5 endpoints
—Owner only—
deals_offers
Deals & offers
Yes
3 endpoints
Yes—Owner only—
dispo
Dispo
Yes
1 endpoint
Yes—Owner only—
transactions
Transactions
Yes
2 endpoints
Yes
1 endpoint
—Owner only—
projects_properties
Projects & properties
Yes
3 endpoints
Yes—Owner only—
tasks
Tasks
Yes
2 endpoints
Yes
3 endpoints
—Owner only—
calendar
Calendar
Yes
2 endpoints
Yes—Owner only—
calls
Calls
Yes
3 endpoints
Yes
1 endpoint
Yes
1 endpoint
——
texts
Texts
Yes
2 endpoints
—Yes
1 endpoint
——
email
Email
Yes
1 endpoint
—Yes
1 endpoint
——
analysis
Analysis
Yes
7 endpoints
————
support
Support tickets
Yes
1 endpoint
————
events
Events
Yes
1 endpoint
————
dialer
Dialer
Yes
1 endpoint
————

Needs approval

New keys start with Needs approval on. Reads always run straight away. While it's on, an endpoint that changes data or reaches a person doesn't run yet. It waits for an owner or admin, and the response is a 202:

{
  "held": true,
  "approvalId": "<approvalId>",
  "requestId": "<requestId>",
  "expiresAt": "2026-10-23T14:30:00.000Z",
  "message": "This key's writes and sends wait for approval. Nothing has been done yet: it runs once an owner or admin approves it, and expires after 7 days."
}
  • Nothing has happened yet. An owner or admin approves or declines it in Approvals. When it's approved, it runs then, as the key's teammate, with every check done again: scopes, record access, compliance.
  • If nobody decides within 7 days, it expires and never runs.
  • An account can have 200 actions waiting. Past that, a new one is refused with 429 and nothing is queued:
{
  "error": "200 API actions are already waiting for approval on this account. Nothing was queued.",
  "code": "queue_full"
}

Over MCP, a held tool call comes back as a normal result that says it's waiting for approval, not as an error.

An owner, an admin or the key's own teammate can turn Needs approval off in Settings › API and agents when that agent may act on its own. In the reference, these endpoints are marked Changes data.

One key, one teammate

Make a separate key for each agent or integration, so you can see what each one did and revoke one without breaking the others.

Keys and scopes | Syntropic Developers