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.
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/v2023-01-24/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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/v2023-01-24/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":"quis aute","attributes":{"name":"exercitation non in amet","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://vmjCOsahoZOLUun.xftoXPLWmoVHxeSf3EHhsaptQHvsRdVUC.wEQFabkSdISI"}},{"type":"segment","id":"cillum veniam ipsum Ut","attributes":{"name":"e","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00"},"links":{"self":"https://uBMGnozsyrHLNHNhBF.prbIe,c6SF1wms4+FvjcXhq1MYSj,"}}],"links":{"self":"https://FqomwXCzzGoKlbLdtpplpliwGuGHjDXPM.jnonMioRNmt","first":"https://rPGblfooikCZlHMNbh.barJyCkgOoHdaou9","last":"https://vXwQmVReJkKZoycTDYgMvfKDK.yveuW14rjgDx9GDCprm.yKHqHlFpDR4Wtw9kTrF6OfCBqVnExIw6eIDXX","prev":"http://wBZ.ygypKpncEyoocT1cR+TaFg1uY09ZRENBrKi,HcjuGtSmF8-y2Wz0Z0CsefDsParqOV","next":"http://eZzJNvNOug.hfynKpZrymuUEe+QonHA6w.i8lCV5iqa-,HwiJk8lSoR0R.wBCCF4f2SfgEopk8N90"}}