Get Segments
GET {{baseUrl}}/api/segments/
Get all segments in an account.
Filter to request a subset of all segments. Segments can be filtered by name, created, and updated fields.
Returns a maximum of 10 results per page, which can be paginated with cursor-based pagination.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
Segments Read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[segment] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>name: any, equals<br>id: any, equals<br>created: greater-than<br>updated: greater-than | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#pagination |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"segment","id":"dolor ipsum","attributes":{"name":"culpa tempor veniam","created":"1993-01-01T07:53:17.446Z","updated":"1960-06-28T12:12:40.621Z"},"links":{"self":"https://VdZGOzEJU.rdFC0xM5JImuQ"}},{"type":"segment","id":"ipsum exercitation","attributes":{"name":"dolore deserunt eu irure Duis","created":"1978-03-11T06:02:09.709Z","updated":"1962-03-06T03:46:16.543Z"},"links":{"self":"https://HTQSvacudtFfuCelio.ulcQ2CAOWxbjY7h0Jz.iZJNs6RPKjKYOr4HzPK.n8982OSjP"}}],"links":{"self":"https://lG.zitsw9h8kOOVqursv3c9Y+OtYe6K-NaLyvtFsn","first":"https://VOe.kgxcecB5eYY,WNzMCMkyQkz,wGDfJE5PuuZCP8-gCw-rBuO16sFMC.oRe","last":"http://KQgsfNkxuQbwPADNMUESbnPf.chouctsTkgK6oGg8,MGlc","prev":"https://yBNBDacvwAqXbGtCbIhjzJTBbmqrX.exahJ-7a-dlFN","next":"http://hhJMhurpLDuTNcDhqlmFcpOdrj.jtitsHeIvx0V0OhgIg,Z+5-qexqZpQ.NxL+QC5IUNygx-GAuOBwJM1zUpHfV.2Z9vL"}}