List
Read a page of objects of a specified type in your HubSpot account. You can control the data returned by specifying properties, associations, and whether to include archived records. This endpoint is useful for retrieving a list of CRM objects with specific details 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.
Path Parameters
The type of CRM object to retrieve, such as contacts, companies, or deals.
Query Parameters
A cursor token for pagination. Use the value from the previous response's paging.next.after field.
Whether to include archived records in the response. Defaults to false.
A comma-separated list of object types to retrieve associated IDs for. If any specified associations do not exist, they will be ignored.
The maximum number of results to display per page. Defaults to 10.
A comma-separated list of property names to include in the response. If any specified properties are not present on the requested object(s), they will be ignored.
A comma-separated list of properties to include in the response along with their history of previous values. If any specified properties are not present on the requested object(s), they will be ignored. Using this parameter reduces the maximum number of objects that can be read in 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 SimplePublicObjectWithAssociations, each representing a CRM object with its properties and associated data.
Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.