SearchRequest

Request body for searching contacts or companies with filters, sorting, and pagination. Follows HubSpot CRM API v3 structure for familiar integration patterns.

filterGroups
Type: array object[] · FilterGroup[] …5

Groups of filters combined with OR logic. Within each group, filters are combined with AND logic. Maximum 5 filter groups allowed (following HubSpot limits).
A group of filters that are combined with AND logic. Multiple filter groups are combined with OR logic. Follows HubSpot-compatible structure for familiar CRM integration patterns.
- filters
  Type: array object[] · Filter[] 1…6
  required
  
  List of filters that are combined with AND logic within this group. At least one filter is required per group. Maximum 6 filters per group (following HubSpot limits).
  
  A single filter condition for search operations. Follows HubSpot-compatible structure for familiar CRM integration patterns.
limit
Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
min:
1
max:
100

Maximum number of results to return per page. Range: 1-100. Defaults to 100.
offset
Type: integer | string Pattern: ^-?(?:0|[1-9]\d*)$Format: int32
min:
0
max:
10000

Number of results to skip (for pagination). Maximum offset: 10,000 (following HubSpot search limit).
query
Type: null | string

Optional free-text query using field:value syntax (e.g., "email:@acme.com tag:vip"). Supported fields depend on entity type. Translated into filterGroups server-side and combined with any explicitly provided filterGroups using AND logic (results must match both the query and the explicit filters).
sorts
Type: array object[] · SortField[] …3

Fields to sort results by, applied in order. Maximum 3 sort fields allowed to prevent query complexity.
Specifies a field to sort search results by. Multiple sort fields are applied in order (first field is primary sort, second is tiebreaker, etc.).
- field
  Type: string
  required
  
  The field name to sort by (e.g., "lastName", "createdUtc", "email"). Must be a valid sortable field for the entity type.
- direction
  Type: string · SortDirectionenum
  
  The sort direction (ascending or descending). Defaults to ascending if not specified.
  
  values
  Asc
  Desc