List
Retrieve a page of CRM objects of a specified type. You can control the data returned by specifying certain properties, associations, and whether to include archived records. This endpoint is useful for fetching a list of objects with specific attributes and associations.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Authorization URL
- https://app.hubspot.com/oauth/authorize
- Token URL
- https://api.hubapi.com/oauth/v1/token
Query Parameters
The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.
Whether to return only results that have been archived.
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.
The maximum number of results to display per page.
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.
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.
Response
successful operation
Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
An array of simple public objects with associations. Each object includes its properties, associations, and metadata.
Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.