GET /categories

Retrieve 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).

Servers

Query parameters

Name Type Required Description
createdSince String No

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.

limit Integer No

Number of documents per page

Default value: 50

name String No

Filter by category name

modifiedSince String No

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.

sort String No

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

ids[] Array No

Filter by category ids

offset Integer No

Index of the first document in the page

Default value: 0

isDeleted String No

Filter categories by their deletion status. If false is passed, only categories that are not deleted will be returned.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.