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

KeyDatatypeRequiredDescription
fields[segment]stringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#sparse-fieldsets
filterstringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):<br>name: any, equals<br>id: any, equals<br>created: greater-than<br>updated: greater-than
page[cursor]stringFor more information please visit https://developers.klaviyo.com/en/v2023-01-24/reference/api-overview#pagination

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;type&quot;:&quot;segment&quot;,&quot;id&quot;:&quot;quis aute&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;exercitation non in amet&quot;,&quot;created&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;updated&quot;:&quot;2022-11-08T00:00:00&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;https://vmjCOsahoZOLUun.xftoXPLWmoVHxeSf3EHhsaptQHvsRdVUC.wEQFabkSdISI&quot;}},{&quot;type&quot;:&quot;segment&quot;,&quot;id&quot;:&quot;cillum veniam ipsum Ut&quot;,&quot;attributes&quot;:{&quot;name&quot;:&quot;e&quot;,&quot;created&quot;:&quot;2022-11-08T00:00:00&quot;,&quot;updated&quot;:&quot;2022-11-08T00:00:00&quot;},&quot;links&quot;:{&quot;self&quot;:&quot;https://uBMGnozsyrHLNHNhBF.prbIe,c6SF1wms4+FvjcXhq1MYSj,&quot;}}],&quot;links&quot;:{&quot;self&quot;:&quot;https://FqomwXCzzGoKlbLdtpplpliwGuGHjDXPM.jnonMioRNmt&quot;,&quot;first&quot;:&quot;https://rPGblfooikCZlHMNbh.barJyCkgOoHdaou9&quot;,&quot;last&quot;:&quot;https://vXwQmVReJkKZoycTDYgMvfKDK.yveuW14rjgDx9GDCprm.yKHqHlFpDR4Wtw9kTrF6OfCBqVnExIw6eIDXX&quot;,&quot;prev&quot;:&quot;http://wBZ.ygypKpncEyoocT1cR+TaFg1uY09ZRENBrKi,HcjuGtSmF8-y2Wz0Z0CsefDsParqOV&quot;,&quot;next&quot;:&quot;http://eZzJNvNOug.hfynKpZrymuUEe+QonHA6w.i8lCV5iqa-,HwiJk8lSoR0R.wBCCF4f2SfgEopk8N90&quot;}}