Companies_ItemsLinkedContactsIds |
Get all CompaniesRetrieve a paginated list of companies with optional filtering, sorting, and search capabilities. Results are sorted by creation date in descending order by default, and can be filtered by attributes, linked contacts, linked deals, or modification/creation timestamps.
Catalog: Brevo
Schema: Companies
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 Companies_ItemsLinkedContactsIds. 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 companies 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. |
filters[attributes.name] |
|
☐ |
|
Filter by attributes. If you have a filter for the owner on your side please send it as filters[attributes.owner] and utilize the account email for the filtering. |
linkedContactsIds |
|
☐ |
|
Filter by linked contacts ids |
linkedDealsIds |
|
☐ |
|
Filter by linked Deals ids |
modifiedSince |
|
☐ |
|
Filter (urlencoded) the companies 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. |
page |
|
☐ |
|
Index of the first document of the page |
sortBy |
|
☐ |
|
The field used to sort field names. |
Columns of Table Function
The columns of the table function Companies_ItemsLinkedContactsIds are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
attributes |
varchar2 |
Attributes |
☐ |
Company attributes with values |
id |
varchar2 |
ID |
☐ |
Unique company id |
TEXT |
int64 |
Text |
☐ |
|
Sendinblue API Data Model