Read and write CRM contacts, companies, and deals via a Private App token
https://api.hubapi.com/crm/v3/objects/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Number of results per page (max 100) |
| after | string | optional | Pagination cursor from a previous response |
| properties | string | optional | Comma-separated property names to include, e.g. 'email,firstname' |
| archived | boolean | optional | Return only archived (deleted) contacts |
/crm/v3/objects/contacts/{contact_id}
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Contact ID, or the value of idProperty if set |
| properties | string | optional | Comma-separated property names to include, e.g. 'email,firstname' |
| idProperty | string | optional | Property to look contact_id up by instead of the internal ID, e.g. 'email' |
/crm/v3/objects/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| properties | object | required | Contact property name/value pairs, e.g. { email: 'a@b.com', firstname: 'Ada' } |
/crm/v3/objects/contacts/{contact_id}
| Param | Type | Required | Description |
|---|---|---|---|
| contact_id | string | required | Contact ID to update |
| properties | object | required | Property name/value pairs to update, e.g. { lifecyclestage: 'customer' } |
/crm/v3/objects/contacts/search
| Param | Type | Required | Description |
|---|---|---|---|
| query | string | optional | Free-text search query across default properties |
| filterGroups | array | optional | OR'd groups of AND'd filters, e.g. [{ filters: [{ propertyName: 'email', operator: 'EQ', value: 'a@b.com' }] }] |
| properties | array | optional | Property names to include in each result |
| sorts | array | optional | Sort specs, e.g. ['-createdate'] |
| limit | integer | optional | Number of results per page (max 100) |
| after | string | optional | Pagination cursor from a previous response |
/crm/v3/objects/companies
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Number of results per page (max 100) |
| after | string | optional | Pagination cursor from a previous response |
| properties | string | optional | Comma-separated property names to include, e.g. 'name,domain' |
/crm/v3/objects/companies
| Param | Type | Required | Description |
|---|---|---|---|
| properties | object | required | Company property name/value pairs, e.g. { name: 'Acme', domain: 'acme.com' } |
/crm/v3/objects/deals
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Number of results per page (max 100) |
| after | string | optional | Pagination cursor from a previous response |
| properties | string | optional | Comma-separated property names to include, e.g. 'dealname,amount,dealstage' |
/crm/v3/objects/deals
| Param | Type | Required | Description |
|---|---|---|---|
| properties | object | required | Deal property name/value pairs, e.g. { dealname: 'New Deal', pipeline: 'default', dealstage: 'appointmentscheduled', amount: '5000' } |