GET /objects/{object_type}/records
Custom objects are only available to Enterprise plans. This feature is in beta. These are subject to change. This API retrieves a list of object records along with their associated records and provides the total count of records for the specified object. Note: Contact as object type is not supported in this endpoint.
Servers
- https://api.brevo.com/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
object_type |
String | Yes |
Object type for the records to retrieve. Must be a previously created custom object type. Contact as object type is not supported in this endpoint. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | Yes |
Number of records returned per page |
page_num |
Integer | Yes |
Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer. |
sort |
String | No |
Sort order, must be 'asc' or 'desc'. Default to 'desc' if not provided. Valid values:
Default value: "desc" |
association |
String | No |
Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided. Valid values:
|
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.