Contacts

Get all the Segments

get/contacts/segments

Request

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

Query parameters

limitinteger required

Number of documents per page

offsetinteger required

Index of the first document of 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

Response

Folders informations

countinteger

Number of Segments available in your account

Example response

{
  "segments": {
    "id": 23,
    "segmentName": "My Segment",
    "categoryName": "New Category",
    "updatedAt": "2017-03-13T17:05:09Z"
  },
  "count": 10
}

Changes

No recorded changes to this operation across all 2 revisions of this API.