post-crm-v3-objects-objtype-search_search
Search HubSpot CRM objects by type using filter groups, text queries, and sorting to retrieve matching records with selected properties.
Instructions
POST /crm/v3/objects/{objectType}/search. REQUIRES body parameter with search criteria. Example: {body: {filterGroups: [{filters: [{propertyName: "email", operator: "EQ", value: "john@example.com"}]}], properties: ["firstname", "lastname", "email"]}}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| after | No | A paging cursor token for retrieving subsequent pages. | |
| limit | No | The maximum results to return, up to 200 objects. | |
| query | No | The search query string, up to 3000 characters. | |
| sorts | No | Specifies sorting order based on object properties. | |
| objectType | Yes | Path parameter objectType | |
| properties | No | A list of property names to include in the response. | |
| filterGroups | No | Up to 6 groups of filters defining additional query criteria. |