HubSpot · Schema

HubSpot CRM Search Request

Schema for a CRM search request body used with POST /crm/v3/objects/{objectType}/search. Supports complex filtering, sorting, and pagination of CRM object records.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name	Type	Description
filterGroups	array	An array of filter groups. Records matching ANY filter group will be included in the results (OR logic between groups). Within each filter group, ALL filters must match (AND logic within a group). Max
sorts	array	An array of sort criteria to order the results. When multiple sort criteria are specified, they are applied in order.
query	string	A full-text search query string. When provided, returns records where any searchable default text property contains the query term. Can be combined with filterGroups for more specific searches.
properties	array	An array of property names to include in the response for each matching record. If not specified, a default set of properties is returned. Use this to request additional properties beyond the defaults
limit	integer	The maximum number of results to return in a single response. Defaults to 10 if not specified. Maximum value is 200.
after	string	The pagination cursor token from the previous response's paging.next.after field. Used to retrieve the next page of search results.

View JSON Schema on GitHub