POST /crm/v3/objects/0-3/batch/read
Retrieve records by record ID or include the idProperty parameter to retrieve records by a custom unique value property.
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" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
archived |
Boolean | No |
Whether to return only results that have been archived. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
inputs[] |
Array | Yes | |
inputs[].id |
String | Yes |
The unique ID of the object. |
properties[] |
Array | Yes |
Key-value pairs for setting properties for the new object. |
idProperty |
String | No |
When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID. |
propertiesWithHistory[] |
Array | Yes |
Key-value pairs for setting properties for the new object and their histories. |
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.