GET /crm/v3/objects/contacts
Read a page of contacts. Control what is returned via the properties query param.
Servers
- https://api.hubapi.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
The maximum number of results to display per page. Default value: 10 |
archived |
Boolean | No |
Whether to return only results that have been archived. Default value: false |
properties[] |
Array | No |
A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. |
associations[] |
Array | No |
A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. |
after |
String | No |
The paging cursor token of the last successfully read resource will be returned as the |
propertiesWithHistory[] |
Array | No |
A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.