# ConsentGroups_ConsentGroups List all consent groups Returns a paginated list of consent groups for the account. This endpoint is only available when the Consent Groups feature is enabled for your account. Returns `403` if the feature is not activated. - Catalog: `Brevo` - Schema: `ConsentGroups` This is a read-only table function. The Brevo API may not support changing the data or the Invantive UniversalSQL driver for Brevo does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Brevo API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `ConsentGroups_ConsentGroups`. 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 | |---|:---:|:---:|:---:|---| | `id` | `` | ☐ | | Filter by consent group ID | | `name` | `` | ☐ | | Filter by name (case-insensitive partial match) | | `signupMode` | `` | ☐ | | Filter by signup mode (Values: manual, automatic) | ## Columns of Table Function The columns of the table function `ConsentGroups_ConsentGroups` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `contactsCount` | `int64` | | ☐ | Number of contacts currently in this consent group | | `createdAt` | `datetime` | Creation Date | ☐ | UTC date-time when the consent group was created (YYYY-MM-DDTHH:mm:ss.SSSZ) | | `description` | `varchar2` | Description | ☐ | Optional description of the consent group | | `id` | `int64` | ID | ☐ | Unique identifier for the consent group | | `isDefault` | `char` | | ☐ | Whether this is a system-created default consent group | | `limit` | `int64` | | ☐ | Maximum number of results returned | | `name` | `varchar2` | Name | ☐ | Display name of the consent group | | `offset` | `int64` | | ☐ | Number of results skipped | | `signupMode` | `varchar2` | | ☐ | Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup. | | `total` | `int64` | Total | ☐ | Total number of consent groups matching the filter | | `updatedAt` | `datetime` | | ☐ | UTC date-time when the consent group was last updated (YYYY-MM-DDTHH:mm:ss.SSSZ) |