Sendinblue API Data Model
Categories |
Return all your categoriesRetrieve a paginated list of all ecommerce categories stored in your Brevo account. Results are sorted by creation date in descending order by default, and can be filtered by category IDs, name, modification date, creation date, or deletion status. The response includes a `count` field with the total number of matching categories, and pagination defaults to 50 categories per page (maximum 100).
Catalog: Brevo
Schema: Ecommerce
Primary Keys: id
Retrieve: true
Insert: true
Update: false
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Categories. 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 categories 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.** |
isDeleted |
|
☐ |
|
Filter categories by their deletion status. If `false` is passed, only categories that are not deleted will be returned. |
modifiedSince |
|
☐ |
|
Filter (urlencoded) the categories 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.** |
name |
|
☐ |
|
Filter by category name |
Columns of Table Function
The columns of the table function Categories 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.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
createdAt |
varchar2 |
Creation Date |
☐ |
Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) |
id |
varchar2 |
ID |
☐ |
Category ID for which you requested the details |
isDeleted |
char |
|
☐ |
category deleted from the shop's database |
modifiedAt |
varchar2 |
Modified Date |
☐ |
Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ) |
name |
varchar2 |
Name |
☐ |
Name of the category for which you requested the details |
url |
varchar2 |
URL |
☐ |
URL to the category |
