Sendinblue API Data Model
records_RecordsAssociations |
Get the list of object records and total records count for an object.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.
Catalog: Brevo
Schema: CustomObjects
This is a read-only table function. The Sendinblue API may not support changing the data or the Invantive UniversalSQL driver for Sendinblue does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Sendinblue API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function records_RecordsAssociations. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
association |
|
☐ |
|
Whether to include associations, must be 'true' or 'false'. Default to 'false' if not provided. (Values: true, false) |
object_type |
|
☑ |
|
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. |
page_num |
|
☑ |
|
Page number for pagination. It's used to fetch the object records on a provided page number. Must be a valid positive integer. |
Columns of Table Function
The columns of the table function records_RecordsAssociations are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
attributes |
varchar2 |
Attributes |
☐ |
Key-value pairs of attribute data for the object record. Each key is the attribute **key** (e.g., `company_name`, `engine_type`), not the attribute label (e.g., "Company Name", "Engine Type"). Only attributes that already exist in the object schema will be present.For `category` or `multiple_category` attributes, the value is the option **key** (not the option label or option ID). |
createdAt |
datetime |
Creation Date |
☐ |
Timestamp when the object record was created |
identifiers_ext_id |
varchar2 |
|
☐ |
External ID of the record in your system. |
identifiers_id |
int64 |
|
☐ |
Internal ID of the object record generated by Brevo. |
object_type |
varchar2 |
|
☐ |
Type of the associated object |
updatedAt |
datetime |
|
☐ |
Timestamp when the object record was last updated |
