Ecommerce

Return all your categories

Changed on
get/categories

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/categories
  • Auth: one of:
    • API key in header api-key
    • API key in header partner-key

Query parameters

limitinteger

Number of documents per page

offsetinteger

Index of the first document in the page

sort'asc' | 'desc'

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

idsstring[]

Filter by category ids

namestring

Filter by category name

modifiedSincestring

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.

createdSincestring

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.

Response

All categories listed

countinteger required

Number of categories

Example response

{
  "categories": [
    {
      "createdAt": "2017-05-12T12:30:00.000+0000",
      "isDeleted": true,
      "modifiedAt": "2017-05-12T12:30:00.000+0000",
      "name": "Electronics",
      "id": "C11",
      "url": "http://mydomain.com/category/clothing"
    }
  ],
  "count": 17655
}

Changes

  • 2aec3cf66501Revision changes
    • info

      added the new optional query request parameter createdSince

    • info

      added the new optional query request parameter modifiedSince

  • 2122e9ffdbe8Revision changes
    • warning

      deleted the query request parameter createdSince

    • warning

      deleted the query request parameter modifiedSince