Developers
Connect your app to ContactRoll
Your own app can tell ContactRoll who signed up, started a trial or used a feature, and keep its people in step with your contacts here, from your server, with a key your team makes. Three requests get you started.
Quick start
Make a key
In ContactRoll, Settings › Connect your app makes an events key, and Settings › API keys makes an API key. Choose one that may write. Each key is shown once: copy it into your server’s environment, as CONTACTROLL_EVENTS_KEY and CONTACTROLL_API_KEY, never into a web page or an app a customer can open. ContactRoll keeps only a fingerprint of it, and an administrator can revoke it at any time.
Send every request from your server, with your app’s name in its User-Agent. Python’s default one is turned away before ContactRoll sees the request.
Send your first contact
Keep a person in step by your app’s own id for them. POST https://app.contactroll.com/api/v1/contacts/upsert finds the contact by your external_id, or else by their email address, and changes it with the fields you send. If nobody has either, it makes them. A new contact answers 201 and a changed one 200, and the ContactRoll-Matched header says how it was found. An Idempotency-Key makes a request that is sent twice count once. Companies work the same way at /api/v1/companies/upsert, by your id for the account, else its domain.
curl
curl -X POST https://app.contactroll.com/api/v1/contacts/upsert \
-H "Authorization: Bearer $CONTACTROLL_API_KEY" \
-H "Content-Type: application/json" \
-H "User-Agent: YourApp-server/1.0" \
-H "Idempotency-Key: u_1842-2026-10-23" \
-d '{"external_id":"u_1842","email":"person@example.com","name":"Ann Lee","status":"trial"}'Node
// Node 18 or later, on your server — never in a browser
const res = await fetch('https://app.contactroll.com/api/v1/contacts/upsert', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.CONTACTROLL_API_KEY}`,
'Content-Type': 'application/json',
'User-Agent': 'YourApp-server/1.0',
'Idempotency-Key': 'u_1842-2026-10-23',
},
body: JSON.stringify({
"external_id": "u_1842",
"email": "person@example.com",
"name": "Ann Lee",
"status": "trial"
}),
})
console.log(res.status, await res.json())Python
# Python 3, on your server. Name your app in the User-Agent: urllib’s own is turned away.
import json, os, urllib.request
req = urllib.request.Request(
"https://app.contactroll.com/api/v1/contacts/upsert",
data=json.dumps({
"external_id": "u_1842",
"email": "person@example.com",
"name": "Ann Lee",
"status": "trial"
}).encode(),
headers={
"Authorization": "Bearer " + os.environ["CONTACTROLL_API_KEY"],
"Content-Type": "application/json",
"User-Agent": "YourApp-server/1.0",
"Idempotency-Key": "u_1842-2026-10-23",
},
method="POST",
)
with urllib.request.urlopen(req) as res:
print(res.status, json.load(res))An address that already belongs to another of your app’s contacts is refused with 409, in words, and never taken over.
Send your first event
One event per request, to https://app.contactroll.com/api/events, with an events key: the person (their address, and your id for them), what happened, and the company they belong to. The company is found by your id for it, else its domain, else made, and the person is linked to it. With a company and no person, the event is about the whole account.
curl
curl -X POST https://app.contactroll.com/api/events \
-H "Authorization: Bearer $CONTACTROLL_EVENTS_KEY" \
-H "Content-Type: application/json" \
-H "User-Agent: YourApp-server/1.0" \
-d '{"email":"person@example.com","external_id":"u_1842","event":"trial_started","company":{"external_id":"acct_77","domain":"example.com","name":"Example Ltd"}}'Node
// Node 18 or later, on your server — never in a browser
const res = await fetch('https://app.contactroll.com/api/events', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.CONTACTROLL_EVENTS_KEY}`,
'Content-Type': 'application/json',
'User-Agent': 'YourApp-server/1.0',
},
body: JSON.stringify({
"email": "person@example.com",
"external_id": "u_1842",
"event": "trial_started",
"company": {
"external_id": "acct_77",
"domain": "example.com",
"name": "Example Ltd"
}
}),
})
console.log(res.status, await res.json())Python
# Python 3, on your server. Name your app in the User-Agent: urllib’s own is turned away.
import json, os, urllib.request
req = urllib.request.Request(
"https://app.contactroll.com/api/events",
data=json.dumps({
"email": "person@example.com",
"external_id": "u_1842",
"event": "trial_started",
"company": {
"external_id": "acct_77",
"domain": "example.com",
"name": "Example Ltd"
}
}).encode(),
headers={
"Authorization": "Bearer " + os.environ["CONTACTROLL_EVENTS_KEY"],
"Content-Type": "application/json",
"User-Agent": "YourApp-server/1.0",
},
method="POST",
)
with urllib.request.urlopen(req) as res:
print(res.status, json.load(res))An event that is recorded answers 202. Then open Settings › Connect your app: What arrived lists the last 20 things your app sent, newest first, each with what ContactRoll did. A sequence can start on an event, and a segment can count them.
SDKs for TypeScript and Python Coming
Two SDKs are built and tested, and are not on npm or PyPI yet. Each is made from the same OpenAPI description as the reference below, and is made again whenever the API changes. Each has a typed model for every record, a method for every operation, lists you read with a loop that follows every page, and a function that checks a webhook’s signature. A request that is safe to send again, such as a read or a write with an Idempotency-Key, is tried again after a 429 or a server error, waiting as long as Retry-After says. The SDKs send your key in the Authorization header and never put it in an error or a log.
Until they are published, each sample does the same as a plain HTTPS request to the same address, as in the quick start above. Five common tasks, each in both languages:
Make or update a contact by your own id
TypeScript
import { ContactRoll } from '@contactroll/sdk'
// Your API key comes from your server's environment, never from your code.
const cr = new ContactRoll({ apiKey: process.env.CONTACTROLL_API_KEY ?? '', appName: 'YourApp/1.0' })
// Found by your own id for the person, else by their email address; made if neither is known.
const contact = await cr.upsertContact(
{ external_id: 'u_1842', email: 'ann@example.com', name: 'Ann Lee', status: 'trial' },
{ idempotencyKey: 'u_1842-2026-11-10' },
)
console.log(contact.id, contact.version)
Python
import os
from contactroll import ContactRoll
# Your API key comes from your server's environment, never from your code.
cr = ContactRoll(api_key=os.environ["CONTACTROLL_API_KEY"], app_name="YourApp/1.0")
# Found by your own id for the person, else by their email address; made if neither is known.
contact = cr.upsert_contact(
{"external_id": "u_1842", "email": "ann@example.com", "name": "Ann Lee", "status": "trial"},
idempotency_key="u_1842-2026-11-10",
)
print(contact["id"], contact["version"])
Read every contact changed since a time, page by page
TypeScript
import { ContactRoll } from '@contactroll/sdk'
const cr = new ContactRoll({ apiKey: process.env.CONTACTROLL_API_KEY ?? '', appName: 'YourApp/1.0' })
// Every contact changed since the time, a page at a time: the iterator follows next_cursor to the last page.
for await (const contact of cr.iterContacts({ updated_since: '2026-11-03T00:00:00Z', limit: 100 })) {
console.log(contact.id, contact.email)
}
Python
import os
from contactroll import ContactRoll
cr = ContactRoll(api_key=os.environ["CONTACTROLL_API_KEY"], app_name="YourApp/1.0")
# Every contact changed since the time, a page at a time: the iterator follows next_cursor to the last page.
for contact in cr.iter_contacts(updated_since="2026-11-03T00:00:00Z", limit=100):
print(contact["id"], contact["email"])
Log a call from another phone system
TypeScript
import { ContactRoll } from '@contactroll/sdk'
const cr = new ContactRoll({ apiKey: process.env.CONTACTROLL_API_KEY ?? '', appName: 'YourPhoneSystem/2.3' })
// A call made on another phone system, put on the record of the contact who has the number.
// The same Idempotency-Key logs it once, however many times it is sent.
const call = await cr.logCall(
{
direction: 'outgoing',
from: '+14155550100',
to: '+14155550123',
started_at: '2026-11-10T15:04:00Z',
duration: 312,
outcome: 'connected',
},
{ idempotencyKey: 'pbx-call-88231' },
)
console.log(call.id, call.contact_id)
Python
import os
from contactroll import ContactRoll
cr = ContactRoll(api_key=os.environ["CONTACTROLL_API_KEY"], app_name="YourPhoneSystem/2.3")
# A call made on another phone system, put on the record of the contact who has the number.
# The same Idempotency-Key logs it once, however many times it is sent.
call = cr.log_call(
{
"direction": "outgoing",
"from": "+14155550100",
"to": "+14155550123",
"started_at": "2026-11-10T15:04:00Z",
"duration": 312,
"outcome": "connected",
},
idempotency_key="pbx-call-88231",
)
print(call["id"], call["contact_id"])
Subscribe to an event, and check each delivery's signature
TypeScript
import { ContactRoll, verifyWebhook } from '@contactroll/sdk'
const cr = new ContactRoll({ apiKey: process.env.CONTACTROLL_API_KEY ?? '', appName: 'YourApp/1.0' })
// Subscribe once. The answer carries the signing secret, once: keep it with your server's other secrets.
const hook = await cr.subscribeHook({ target_url: 'https://example.com/contactroll/hooks', event: 'contact.created' })
console.log('subscribed', hook.id)
// In your endpoint: check the signature over the body exactly as it arrived, before you parse it.
export async function onDelivery(rawBody: string, headers: Headers) {
const event = await verifyWebhook({ body: rawBody, headers, secret: process.env.CONTACTROLL_WEBHOOK_SECRET ?? '' })
// Take each event id once: a delivery that is sent again keeps its id.
console.log(event.type, event.id)
}
Python
import os
from contactroll import ContactRoll, verify_webhook
cr = ContactRoll(api_key=os.environ["CONTACTROLL_API_KEY"], app_name="YourApp/1.0")
# In your endpoint: check the signature over the body exactly as it arrived, before you parse it.
def on_delivery(raw_body: bytes, headers) -> None:
event = verify_webhook(raw_body, headers, secret=os.environ["CONTACTROLL_WEBHOOK_SECRET"])
# Take each event id once: a delivery that is sent again keeps its id.
print(event["type"], event["id"])
if __name__ == "__main__":
# Subscribe once. The answer carries the signing secret, once: keep it with your server's other secrets.
hook = cr.subscribe_hook({"target_url": "https://example.com/contactroll/hooks", "event": "contact.created"})
print("subscribed", hook["id"])
Open a case and add a note to it
TypeScript
import { ContactRoll } from '@contactroll/sdk'
const cr = new ContactRoll({ apiKey: process.env.CONTACTROLL_API_KEY ?? '', appName: 'YourApp/1.0' })
// Find the person by their address, open a case for them, and add a note your team will see.
const { data: [person] } = await cr.listContacts({ email: 'person1@example.com' })
if (!person?.id) throw new Error('No contact has that address')
const opened = await cr.createCase({ contact_id: person.id, subject: 'Invoice question', priority: 'high' })
await cr.createNote({ case_id: String(opened.id), body: 'Asked for a copy of the October invoice.' })
console.log('case', opened.number)
Python
import os
from contactroll import ContactRoll
cr = ContactRoll(api_key=os.environ["CONTACTROLL_API_KEY"], app_name="YourApp/1.0")
# Find the person by their address, open a case for them, and add a note your team will see.
people = cr.list_contacts(email="person1@example.com")["data"]
if not people:
raise SystemExit("No contact has that address")
opened = cr.create_case({"contact_id": people[0]["id"], "subject": "Invoice question", "priority": "high"})
cr.create_note({"case_id": opened["id"], "body": "Asked for a copy of the October invoice."})
print("case", opened["number"])
The events
An event carries no free text. Every field is named, and a field nobody named is refused with its name. Only the status events change a contact’s status.
| event | name | The contact |
|---|---|---|
signed_up | — | No change |
trial_started | — | Trial |
became_active | — | Active |
canceled | — | Canceled |
feature_used | Required: the feature, such as export | No change |
custom | Required: your own event, such as invited_teammate | No change |
plan_changed | to required, from optional: the plan’s name, no prices | Sets the contact’s plan |
login | — | Sets last seen, at most once an hour a person |
Webhooks
On Plus, ContactRoll can tell your server when something changes. Add an endpoint under Settings › Webhooks (an https address of your own, up to ten an organization) and choose which of these it is sent:
| Event | What it means | Area |
|---|---|---|
contact.created | A contact was made: by a person, an import, a form, the API or an email that arrived. | contacts |
contact.updated | One of a contact's fields changed. | contacts |
contact.merged | Two contacts became one: the one kept, and the id of the one merged into it. | contacts |
contact.deleted | A contact was put in Trash. | contacts |
contact.restored | A contact was taken out of Trash. | contacts |
contact.erased | A person was erased at their request: only their id is sent. | contacts |
contact.unsubscribed | A person unsubscribed from the organization's marketing email. | marketing |
company.created | A company was made. | companies |
company.updated | One of a company's fields changed. | companies |
company.merged | Two companies became one: the one kept, and the id of the one merged into it. | companies |
company.deleted | A company was put in Trash. | companies |
company.restored | A company was taken out of Trash. | companies |
deal.created | A deal was made. | deals |
deal.updated | One of a deal's fields changed, its stage among them. | deals |
deal.deleted | A deal was put in Trash. | deals |
deal.restored | A deal was taken out of Trash. | deals |
case.created | A case was opened: by an email, a call, a chat, a form, a person or the API. | cases |
case.updated | One of a case's fields changed: its status, priority or who it is assigned to. | cases |
case.replied | A reply was added to a case, by the customer or the team (an internal note is never sent). | cases |
case.deleted | A case was put in Trash. | cases |
case.restored | A case was taken out of Trash. | cases |
call.ended | A call ended, or was logged: its direction, number, length and outcome. | calls |
call.recorded | A call's recording was made: the call's id and the recording's length, never the sound. | calls |
call.voicemail | A caller left a voicemail: the call's id and its length, never the sound. | calls |
custom_record.created | A record of one of the organization's own kinds was made (its type is the kind's key). | contacts |
custom_record.updated | A record of one of the organization's own kinds changed. | contacts |
custom_record.deleted | A record of one of the organization's own kinds was put in Trash. | contacts |
custom_record.restored | A record of one of the organization's own kinds was taken out of Trash. | contacts |
member.role_changed | A member's role changed: the role by its key, and whether it is one of the organization's own. | admin |
An endpoint hears only the events you tick for it. A REST hook made with a key hears only an event in an area the key may read, and stops hearing it the moment the key no longer may.
call.recorded is sent when a call’s recording is ready, and call.voicemail when a caller leaves a voicemail. Each names the recording by its id, with its contact, its call, its direction, its length and when it was made, never the audio.
Each delivery is a JSON POST carrying the record’s id and the fields that changed, signed with HMAC-SHA256 in ContactRoll-Signature, using a secret that is shown once. Refuse a timestamp more than five minutes old, and take each ContactRoll-Webhook-Id once. An answer other than 2xx is tried again, seven times over about twenty hours. Each endpoint keeps its last 25 deliveries, with what your server answered and Send it again.
The MCP server
On Plus, an MCP client, such as Claude Code, can search, read and, if you allow it, update your records at https://app.contactroll.com/api/mcp. It connects with an API key, which reads only unless an Owner or Administrator allows MCP writes on it, or, for a client that uses OAuth, with a member’s own sign-in and their yes on ContactRoll’s consent page.
Either way it does no more than the member may: their role, the records they reach and the masking of sensitive numbers apply, and each call is an entry in the audit log. Each member sees their connections, an Owner sees everyone’s, and either can revoke one at once.
The API reference
Every operation of the API, with its fields, its answers and a curl example on your own organization’s address, is in ContactRoll under Settings › API reference, for every member: app.contactroll.com/settings/api once you are signed in. It is drawn from the same OpenAPI 3.1 description the code is checked against on every change. Each API key has a rate of its own, 120 requests a minute unless an administrator sets another, and the headers of each answer say what is left.
Your calls, and a contact’s companies
GET /api/v1/calls lists your organization’s calls, oldest first and a page at a time, to keep them in another system. It filters by when the call was made, its direction, its outcome, how it was logged, and its contact, case, deal or member. It never carries a call’s notes or its recording. A contact read through the API also carries companies: every company the person belongs to, with their role there and which one is primary.
Log calls from any phone system
POST /api/v1/calls puts a call made on another phone system on the record: direction (incoming or outgoing), from and to in E.164, started_at, duration in seconds, outcome, and a recording_url if your phone system keeps the recording. The call goes to the contact who has the number on their side: to on an outgoing call, from on an incoming one. Send contact_id to say whose call it was, which you must do when two contacts share the number. It needs a read-and-write key whose maker may log calls, and only reaches the contacts that member can see. Send an Idempotency-Key so a call sent twice is logged once. It fires call.ended, as every call does.
curl
curl -X POST "https://app.contactroll.com/api/v1/calls" \
-H "Authorization: Bearer $CONTACTROLL_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: call-8f2c41" \
-d '{"direction":"outgoing","from":"+16155550100","to":"+14155550142",
"started_at":"2026-10-29T15:04:05Z","duration":312,"outcome":"connected",
"recording_url":"https://phones.example.com/recordings/RE123"}'For tools that poll or subscribe, like Zapier
GET /api/v1/me answers with your organization’s name, the key, and what it may do: a test of a key that changes nothing. A key can subscribe a REST hook with POST /api/v1/hooks, naming one event and an https address, and remove it with DELETE /api/v1/hooks/<id>. A hook hears only about records the key’s maker can see, is signed like every webhook, and goes when the key is revoked or its address answers 410.
Lists take order=newest or order=updated, each record keeping its id. You can find a contact by phone number, a company by name and a deal by name. GET /api/v1/stages lists your pipeline stages, and POST /api/v1/notes adds a note to a contact, company, deal or case. A ContactRoll app for Zapier is built on these, and is not published yet.
Change only what you read
Every contact, company, deal and case carries a version, and a read or a change of one answers with it as an ETag. Send it back as If-Match on a PATCH: if somebody changed the record since you read it, the change is refused with 412 and the version it is at now, and nothing is changed.
Bulk import and export
On Plus, POST /api/v1/bulk/import takes up to 100,000 contacts in one request, as JSON or as a CSV file, and POST /api/v1/bulk/export writes every contact, company, deal or case the key’s maker can see. Each is a job that runs on its own: GET /api/v1/bulk/jobs/<id> says how far it is, and its errors and results come a page at a time, as JSON or CSV. Two jobs at a time.
curl
curl -X POST "https://app.contactroll.com/api/v1/bulk/import?existing=skip" \
-H "Authorization: Bearer $CONTACTROLL_API_KEY" \
-H "Content-Type: text/csv" \
-H "User-Agent: YourApp-server/1.0" \
-H "Idempotency-Key: import-2026-10-29" \
--data-binary @contacts.csvRequests a minute, by plan
A key makes as many requests a minute as it was made with, and never more than its plan allows: 120 on Standard, 600 on Plus. X-RateLimit-Limit says the number that applies.
Your own record types
On Plus, the record types your organization makes for itself, like properties or vehicles, are in the API too. GET /api/v1/objects lists them, each with its key and its fields; /api/v1/objects/<key>/records lists, adds, reads, changes and deletes their records, newest first, with q to look for a name, a version and If-Match as above; and /records/<id>/links links a record to a contact, a company, a deal or a case. A key does only what its maker’s role may do with that type. Webhooks say when a record is made, changed or deleted, and a bulk job imports or exports one type’s records.
What a key may reach
When a key is made, you choose what it may reach, area by area: nothing, read, or read and change. A request outside it is refused with 403 and insufficient_scope, in words that say what the key may reach. A key made before scopes keeps every area until its scopes are changed, and the API keys page says so. Within its areas a key still does no more than the member who made it may.
contacts: contacts, their notes and tasks, and the organization's own kinds of record (/contacts, /notes, /tasks, /objects)companies: companies (/companies)deals: deals and the pipeline's stages (/deals, /stages)cases: support cases (/cases)calls: calls, and logging a call from another phone system (/calls)marketing: the events of a person's marketing email (contact.unsubscribed)flows: nothing in the API yetwebhooks: the key's own REST hooks (/hooks)admin: the organization's members, custom fields and bulk jobs (/members, /custom_fields, /bulk), and member.role_changed
Your own app, with OAuth
On Plus, an Owner can register an app of the organization’s own under Settings › Connected apps: its name, its redirect addresses and the areas it may ask for. It is given a client ID and a client secret, shown once. The app sends a member to https://app.contactroll.com/mcp/authorize with PKCE (S256) and the scopes it wants, like contacts:read deals:write; the member sees what it asks for and says yes or no. It trades the code at https://app.contactroll.com/api/oauth/token for an access token of an hour and a refresh token of 30 days, and calls https://app.contactroll.com/api/v1 with the access token as a Bearer token. The token acts as that member, in those areas, and stops when the member leaves, the connection is ended on Connected apps, or the app is removed.
Every operation, and try it
Every operation of the API, from the same OpenAPI 3.1 description the code is checked against on every change (openapi.json). Each says the area it needs. A read without an id can be tried here with your own API key: it is sent from this page, in your browser, straight to https://app.contactroll.com/api/v1, and to nothing else. It is not stored anywhere, not even in this browser, and is gone when you leave the page. Use a read key you can revoke afterwards.
Only reads are tried here; nothing you try changes anything.
Trying a request needs JavaScript; every operation is still listed below.
/contacts
GET/contactsList contactsNeeds contacts: readPOST/contactsMake a contactNeeds contacts: writePOST/contacts/upsertMake or change a contact, found by your app's idNeeds contacts: writeGET/contacts/{id}Read a contactNeeds contacts: readPATCH/contacts/{id}Change a contactNeeds contacts: write
/companies
GET/companiesList companiesNeeds companies: readPOST/companiesMake a companyNeeds companies: writePOST/companies/upsertMake or change a company, found by your app's idNeeds companies: writeGET/companies/{id}Read a companyNeeds companies: readPATCH/companies/{id}Change a companyNeeds companies: write
/deals
GET/dealsList dealsNeeds deals: readPOST/dealsMake a dealNeeds deals: writeGET/deals/{id}Read a dealNeeds deals: readPATCH/deals/{id}Change a dealNeeds deals: write
/cases
GET/casesList casesNeeds cases: readPOST/casesMake a caseNeeds cases: writeGET/cases/{id}Read a caseNeeds cases: readPATCH/cases/{id}Change a caseNeeds cases: write
/members
GET/membersList members and their rolesNeeds admin: read
/custom_fields
GET/custom_fieldsList the organization's custom fieldsNeeds admin: read
/calls
GET/callsList callsNeeds calls: readPOST/callsLog a callNeeds calls: write
/bulk
POST/bulk/importImport contacts, or a kind's records, as a jobNeeds admin: writePOST/bulk/exportExport records as a jobNeeds admin: writeGET/bulk/jobsList this key's bulk jobsNeeds admin: readGET/bulk/jobs/{id}Read a bulk jobNeeds admin: readGET/bulk/jobs/{id}/errorsRead a bulk job's failed rowsNeeds admin: readGET/bulk/jobs/{id}/resultsRead an export's recordsNeeds admin: read
/me
GET/meWho this key isNeeds no area
/hooks
GET/hooksList this key's hooksNeeds webhooks: readPOST/hooksSubscribe a REST hookNeeds webhooks: writeDELETE/hooks/{id}Unsubscribe a REST hookNeeds webhooks: write
/stages
GET/stagesList pipeline stagesNeeds deals: read
/notes
POST/notesAdd a noteNeeds contacts: write
/objects
GET/objectsList the organization's own kinds of recordNeeds contacts: readGET/objects/{key}Read one kind of recordNeeds contacts: readGET/objects/{key}/recordsList a kind's recordsNeeds contacts: readPOST/objects/{key}/recordsMake a record of a kindNeeds contacts: writeGET/objects/{key}/records/{id}Read a record of a kindNeeds contacts: readPATCH/objects/{key}/records/{id}Change a record of a kindNeeds contacts: writeDELETE/objects/{key}/records/{id}Delete a record of a kindNeeds contacts: writeGET/objects/{key}/records/{id}/linksList a record's linksNeeds contacts: readPOST/objects/{key}/records/{id}/linksLink a record to a contact, a company, a deal or a caseNeeds contacts: writeDELETE/objects/{key}/records/{id}/links/{link_id}Unlink a recordNeeds contacts: write
/relationships
GET/relationshipsList the organization's relationship typesNeeds contacts: readGET/relationships/{type}Read one relationship typeNeeds contacts: readGET/relationships/{type}/linksList a relationship's linksNeeds contacts: readPOST/relationships/{type}/linksRelate two recordsNeeds contacts: writeGET/relationships/{type}/links/{link_id}Read a linkNeeds contacts: readPATCH/relationships/{type}/links/{link_id}Change a link's attributesNeeds contacts: writeDELETE/relationships/{type}/links/{link_id}Remove a linkNeeds contacts: write
/tasks
GET/tasksList tasksNeeds contacts: readPOST/tasksMake a taskNeeds contacts: writeGET/tasks/{id}Read a taskNeeds contacts: readPATCH/tasks/{id}Change a taskNeeds contacts: write
Which plan has what
| What your app can do | Free | Standard | Plus |
|---|---|---|---|
| Events from your app, about a person | Included | Included | Included |
| A company in an event, and events about a whole account | Not included | Included | Included |
| Settings › Connect your app, with what arrived | Not included | Included | Included |
| Contacts and companies kept in step by your own id (upsert) | Not included | Included | Included |
| The whole API: read and write contacts, companies, deals, cases and more | Not included | Not included | Included |
| Webhooks | Not included | Not included | Included |
| API requests a minute, at most | Not included | 120 | 600 |
| Bulk import and export, 100,000 rows a job | Not included | Not included | Included |
On Free, events keys are made on the Team page. On Standard, an API key makes the two upserts and nothing else.