CRM

Every CRM API endpoint, grouped by what it works on. Organization- and event-level endpoints sit side by side, with the scope each one needs.

Home

Endpoint	Level	Needs
GET Get CRM Home/v1/organization/{orgId}/crm	Organization	read:crm

Contacts

Endpoint	Level	Needs
GET List contacts/v1/organization/{orgId}/crm/contacts	Organization	read:crm
POST Add a contact/v1/organization/{orgId}/crm/contacts	Organization	write:crm
GET Get a contact/v1/organization/{orgId}/crm/contacts/{contactId}	Organization	read:crm
PUT Update a contact/v1/organization/{orgId}/crm/contacts/{contactId}	Organization	write:crm
POST Add a note to a contact/v1/organization/{orgId}/crm/contacts/{contactId}/notes	Organization	write:crm
POST Change types and tags on many contacts/v1/organization/{orgId}/crm/contacts/bulk	Organization	write:crm
DELETE Delete contacts/v1/organization/{orgId}/crm/contacts	Organization	write:crm
GET Export contacts/v1/organization/{orgId}/crm/contacts/export	Organization	read:crm
GET List fields/v1/organization/{orgId}/crm/fields	Organization	read:crm

Tags

Endpoint	Level	Needs
GET List tags/v1/organization/{orgId}/crm/tags	Organization	read:crm
POST Create a tag/v1/organization/{orgId}/crm/tags	Organization	write:crm
PUT Rename a tag/v1/organization/{orgId}/crm/tags/{tagId}	Organization	write:crm
DELETE Delete a tag/v1/organization/{orgId}/crm/tags/{tagId}	Organization	write:crm

Import

Endpoint	Level	Needs
GET Download the sample file/v1/organization/{orgId}/crm/import/sample	Organization	read:crm
POST Read a spreadsheet's columns/v1/organization/{orgId}/crm/import/parse	Organization	read:crm
POST Preview an import/v1/organization/{orgId}/crm/import/preview	Organization	read:crm
POST Import contacts/v1/organization/{orgId}/crm/import	Organization	write:crm

Connections

Endpoint	Level	Needs
GET List connections/v1/organization/{orgId}/crm/apps	Organization	read:crm
POST Connect an app/v1/organization/{orgId}/crm/apps/{appId}/connect	Organization	write:crm
POST Test a connection/v1/organization/{orgId}/crm/apps/{appId}/test	Organization	write:crm
DELETE Disconnect an app/v1/organization/{orgId}/crm/apps/{appId}	Organization	write:crm
GET List an event platform's events/v1/organization/{orgId}/crm/apps/{appId}/remote-events	Organization	read:crm
POST Discover people in an app/v1/organization/{orgId}/crm/apps/{appId}/discover	Organization	read:crm
POST Bring in an event's attendees/v1/organization/{orgId}/crm/apps/{appId}/attendees	Organization	write:crm
PUT Keep a source in sync/v1/organization/{orgId}/crm/apps/{appId}/sync	Organization	write:crm

Pipeline

Endpoint	Level	Needs
GET List pipeline entries/v1/organization/{orgId}/crm/pipeline	Organization	read:crm
GET List pipeline stages/v1/organization/{orgId}/crm/pipeline/stages	Organization	read:crm
POST Add contacts to the pipeline/v1/organization/{orgId}/crm/pipeline	Organization	write:crm
PATCH Move a pipeline entry/v1/organization/{orgId}/crm/pipeline/{entryId}	Organization	write:crm
DELETE Archive a pipeline entry/v1/organization/{orgId}/crm/pipeline/{entryId}	Organization	write:crm
GET Get a pipeline entry's history/v1/organization/{orgId}/crm/pipeline/{entryId}/history	Organization	read:crm
GET Export the pipeline/v1/organization/{orgId}/crm/pipeline/export	Organization	read:crm

Contracts

Endpoint	Level	Needs
GET List contracts/v1/organization/{orgId}/crm/contracts	Organization	read:crm
GET Get a contract/v1/organization/{orgId}/crm/contracts/{contractId}	Organization	read:crm
POST Send a contract/v1/organization/{orgId}/crm/contracts	Organization	write:crm
POST Resend a contract/v1/organization/{orgId}/crm/contracts/{contractId}/resend	Organization	write:crm
POST Void a contract/v1/organization/{orgId}/crm/contracts/{contractId}/void	Organization	write:crm
GET Get a contract's PDF/v1/organization/{orgId}/crm/contracts/{contractId}/pdf	Organization	read:crm
GET Export contracts/v1/organization/{orgId}/crm/contracts/export	Organization	read:crm
GET List contract templates/v1/organization/{orgId}/crm/contract-templates	Organization	read:crm
POST Add a starter template/v1/organization/{orgId}/crm/contract-templates/starter	Organization	write:crm

People

Endpoint	Level	Needs
GET List people/v1/organization/{orgId}/crm/people	Organization	read:crm
GET Get a person/v1/organization/{orgId}/crm/people/{key}	Organization	read:crm
POST Add a person/v1/organization/{orgId}/crm/people	Organization	write:crm
PUT Update a person/v1/organization/{orgId}/crm/people/{key}	Organization	write:crm
DELETE Delete people/v1/organization/{orgId}/crm/people	Organization	write:crm
POST Tag or untag people/v1/organization/{orgId}/crm/people/roles	Organization	write:crm
POST Add people to contacts/v1/organization/{orgId}/crm/people/add-to-contacts	Organization	write:crm
GET Export people/v1/organization/{orgId}/crm/people/export	Organization	read:crm

Companies

Endpoint	Level	Needs
GET List companies/v1/organization/{orgId}/crm/companies	Organization	read:crm
GET Get a company/v1/organization/{orgId}/crm/companies/{companyId}	Organization	read:crm
POST Add a company/v1/organization/{orgId}/crm/companies	Organization	write:crm
PUT Update a company/v1/organization/{orgId}/crm/companies/{companyId}	Organization	write:crm
DELETE Delete companies/v1/organization/{orgId}/crm/companies	Organization	write:crm
POST Link people to a company/v1/organization/{orgId}/crm/companies/{companyId}/people	Organization	write:crm
DELETE Unlink a person from a company/v1/organization/{orgId}/crm/companies/{companyId}/people/{key}	Organization	write:crm
GET Export companies/v1/organization/{orgId}/crm/companies/export	Organization	read:crm

Hand-offs

Endpoint	Level	Needs
GET List hand-off apps/v1/organization/{orgId}/crm/handoffs	Organization	read:crm
POST Hand people to an app/v1/organization/{orgId}/crm/handoffs/tag	Organization	write:crm