POST /crm/v3/objects/0-3/search
Search for deals using specified criteria and filters.
Servers
- https://api.hubapi.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
filterGroups[] |
Array | Yes |
Up to 6 groups of filters defining additional query criteria. |
filterGroups[].filters[] |
Array | Yes | |
filterGroups[].filters[].propertyName |
String | Yes |
The name of the property to apply the filter to. |
filterGroups[].filters[].values[] |
Array | No |
The values to match against the property. |
filterGroups[].filters[].operator |
String | Yes |
null Valid values:
|
filterGroups[].filters[].value |
String | No |
The value to match against the property. |
filterGroups[].filters[].highValue |
String | No |
The upper boundary value when using ranged-based filters. |
query |
String | No |
The search query string, up to 3000 characters. |
sorts[] |
Array | Yes |
Specifies sorting order based on object properties. |
limit |
Integer | Yes |
The maximum results to return, up to 200 objects. |
properties[] |
Array | Yes |
A list of property names to include in the response. |
after |
String | Yes |
A paging cursor token for retrieving subsequent pages. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.