Search
AI-generatedSummary
Search HubSpot objects of a specified type using JSON-formatted filters, returning selected properties and optionally including associated objects.
Inputs
- Object Type (required) — The HubSpot object type to search, such as contacts, companies, deals, or a custom object name.
- Filters (JSON) (required) — JSON array of search filters specifying propertyName, operator, and value to filter objects.
- Properties — Comma-separated list of object properties to return in the results.
- Associations — Comma-separated list of associated object types to include in each result.
- Limit — Maximum number of results to return per request, up to 100.
- Return All — Whether to retrieve all matching results by automatically paginating through them; if false, returns up to the specified limit.
Output shape
a list of objects matching the search criteria, each including requested properties and associations
If 'Return All' is true, results are paginated automatically and all matches are returned; otherwise, up to 'Limit' items are returned.
Examples
Example 1: Search for contacts with a specific email
Object Type: contacts; Filters: [{"propertyName": "email", "operator": "EQ", "value": "test@example.com"}]; Properties: firstname,lastname,email; Return All: false; Limit: 10