Contacts: Sendinblue Contacts |
Get all the contactsRetrieve all contacts from your Brevo account with support for pagination, filtering, and sorting. Results default to 50 contacts per page (maximum 1000) sorted in descending order of creation, and can be filtered by modification date, creation date, contact IDs (up to 20), list IDs, segment ID, or contact attributes using the equals operator. Note that either listIds or segmentId can be passed but not both simultaneously.
Catalog: Brevo
Schema: Contacts
Primary Keys: id
Label: Contacts
Can retrieve data and change data using insert, update and delete.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Contacts. 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 |
|---|---|---|---|---|
createdSince |
|
☐ |
|
Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** |
filter |
|
☐ |
|
Filter the contacts on the basis of attributes. **Allowed operator: equals. For multiple-choice options, the filter will apply an AND condition between the options. For category attributes, the filter will work with both id and value. (e.g. filter=equals(FIRSTNAME,"Antoine"), filter=equals(B1, true), filter=equals(DOB, "1989-11-23"), filter=equals(GENDER, "1"), filter=equals(GENDER, "MALE"), filter=equals(COUNTRY,"USA, INDIA")** |
modifiedSince |
|
☐ |
|
Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** |
segmentId |
|
☐ |
|
Id of the segment. **Either listIds or segmentId can be passed.** Must be a positive integer (minimum value of 1). |
Columns of Table Function
The columns of the table function Contacts are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
ABONNEMENTEN_ACTIEF_TOT |
varchar2 |
|
☐ |
|
ABONNEMENTEN_ACTIEF |
varchar2 |
|
☐ |
|
BLACKLIST |
decimal |
Blacklist |
☐ |
|
BUBS_GBR_ID_MASTER |
decimal |
|
☐ |
|
BUBS_GBR_ID |
decimal |
Estate Person ID |
☐ |
|
CLICKERS |
decimal |
Clickers |
☐ |
|
COMPANY_NAME |
varchar2 |
Company Name |
☐ |
|
CONTACT_TIMEZONE |
varchar2 |
|
☐ |
|
CONTRACT_CODE |
varchar2 |
Contract Code |
☐ |
|
COUNTRY |
varchar2 |
Country |
☐ |
|
createdAt |
varchar2 |
Creation Date |
☐ |
Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
D31APPLICATIONS |
varchar2 |
|
☐ |
|
D31BILLINGIDS |
varchar2 |
|
☐ |
|
D31BUBSGBRIDS |
varchar2 |
|
☐ |
|
D31DATACONTAINERCNT |
decimal |
|
☐ |
|
D31MBIO |
decimal |
|
☐ |
|
D31PARTITIONCNT |
decimal |
|
☐ |
|
D31PROVIDERCNT |
decimal |
|
☐ |
|
D31ROWCNT |
decimal |
|
☐ |
|
D31TABLECNT |
decimal |
|
☐ |
|
DOUBLE_OPT-IN |
varchar2 |
|
☐ |
|
varchar2 |
Email Address |
☐ |
Email address of the contact for which you requested the details |
|
emailBlacklisted |
char |
Email is Blacklisted |
☐ |
Blacklist status for email campaigns (true=blacklisted, false=not blacklisted) |
EXT_ID |
varchar2 |
|
☐ |
|
FIRSTNAME |
varchar2 |
First Name |
☐ |
|
FORUMS_LOGIN |
varchar2 |
Forums Login |
☐ |
|
id |
int64 |
ID |
☐ |
ID of the contact for which you requested the details |
JOB_TITLE |
varchar2 |
|
☐ |
|
JOBTITLE |
varchar2 |
Job Title |
☐ |
|
LANDLINE_NUMBER |
varchar2 |
|
☐ |
|
LANGUAGE_CODE |
varchar2 |
Language Code |
☐ |
|
LASTNAME |
varchar2 |
Last Name |
☐ |
|
varchar2 |
|
☐ |
|
|
listIds |
varchar2 |
List IDs |
☐ |
|
listUnsubscribed |
varchar2 |
Unsubscribed List IDs |
☐ |
|
MOBILE_NUMBER |
varchar2 |
Mobile Number |
☐ |
|
modifiedAt |
varchar2 |
Modified Date |
☐ |
Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ) |
OPT_IN |
char |
|
☐ |
|
PHONE_NUMBER |
varchar2 |
Phone Number |
☐ |
|
PRIMARY_AUDIENCE |
varchar2 |
Primary Audience |
☐ |
|
READERS |
decimal |
Readers |
☐ |
|
SMS |
varchar2 |
SMS |
☐ |
|
smsBlacklisted |
char |
SMS is Blacklisted |
☐ |
Blacklist status for SMS campaigns (true=blacklisted, false=not blacklisted) |
varchar2 |
☐ |
|
||
whatsappBlacklisted |
char |
|
☐ |
Blacklist status for WhatsApp campaigns (true=blacklisted, false=not blacklisted) |
Sendinblue API Data Model