Get Segment Profiles

GET {{baseUrl}}/api/segments/:segment_id/profiles/

Get all profiles within the given segment ID. Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number, and push_token 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: Profiles Read Segments Read

Request Params

KeyDatatypeRequiredDescription
fields[profile]stringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#sparse-fieldsets
filterstringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):<br>email: any<br>phone_number: any<br>push_token: any<br>_kx: equals
page[cursor]stringFor more information please visit https://developers.klaviyo.com/en/v2022-10-17/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;profile&quot;,&quot;id&quot;:&quot;nostrud ul&quot;,&quot;attributes&quot;:{&quot;email&quot;:&quot;ut amet eu irure&quot;,&quot;phone_number&quot;:&quot;proident id&quot;,&quot;external_id&quot;:&quot;commod&quot;,&quot;anonymous_id&quot;:&quot;Excepteur in&quot;,&quot;first_name&quot;:&quot;exercitation id&quot;,&quot;last_name&quot;:&quot;in exercitation commodo Ut fugiat&quot;,&quot;organization&quot;:&quot;sit dolore&quot;,&quot;title&quot;:&quot;velit&quot;,&quot;image&quot;:&quot;ea nisi Duis ut&quot;,&quot;created&quot;:&quot;1998-05-08T06:12:37.538Z&quot;,&quot;updated&quot;:&quot;2014-08-24T02:58:43.857Z&quot;,&quot;last_event_date&quot;:&quot;1974-09-27T03:07:12.670Z&quot;,&quot;location&quot;:{&quot;address1&quot;:&quot;quis&quot;,&quot;address2&quot;:&quot;mollit&quot;,&quot;city&quot;:&quot;amet enim quis&quot;,&quot;country&quot;:&quot;non&quot;,&quot;latitude&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;longitude&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;region&quot;:&quot;irure culpa Duis&quot;,&quot;zip&quot;:&quot;qui &quot;,&quot;timezone&quot;:&quot;aliqua non&quot;},&quot;properties&quot;:{}},&quot;links&quot;:{&quot;self&quot;:&quot;http://GgojnuJFoIngth.ospZumnegvCGJhExrTncHqwV-ASmR,+vTRRQ28&quot;}},{&quot;type&quot;:&quot;profile&quot;,&quot;id&quot;:&quot;quis pariatur nisi ullamco fugiat&quot;,&quot;attributes&quot;:{&quot;email&quot;:&quot;Ut nisi irure officia&quot;,&quot;phone_number&quot;:&quot;sunt in nisi&quot;,&quot;external_id&quot;:&quot;ad do ex dolore&quot;,&quot;anonymous_id&quot;:&quot;aute veniam&quot;,&quot;first_name&quot;:&quot;reprehenderit proident in dolore&quot;,&quot;last_name&quot;:&quot;Ut exercitation fugiat&quot;,&quot;organization&quot;:&quot;fugiat adipisicing pariatur ex&quot;,&quot;title&quot;:&quot;sint culpa dolore exercitation magna&quot;,&quot;image&quot;:&quot;est aliqua commodo ut Excepteur&quot;,&quot;created&quot;:&quot;1967-08-11T23:47:23.855Z&quot;,&quot;updated&quot;:&quot;1967-06-26T13:15:39.927Z&quot;,&quot;last_event_date&quot;:&quot;2000-02-25T07:16:48.326Z&quot;,&quot;location&quot;:{&quot;address1&quot;:&quot;labore&quot;,&quot;address2&quot;:&quot;in enim in&quot;,&quot;city&quot;:&quot;occaecat adipisicing&quot;,&quot;country&quot;:&quot;sit enim velit&quot;,&quot;latitude&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;longitude&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},&quot;region&quot;:&quot;esse nisi&quot;,&quot;zip&quot;:&quot;reprehenderit ea&quot;,&quot;timezone&quot;:&quot;do ea aliqua aliquip&quot;},&quot;properties&quot;:{}},&quot;links&quot;:{&quot;self&quot;:&quot;https://VtjePrNMzolQxYrwVhPiwAfzn.qtv5p7qbrhVfy4FtCG-7vxNH012gaKQcSIi1vLsVQ37aS-SmtaJurvr15DDohCRqkCpgIY&quot;}}],&quot;links&quot;:{&quot;self&quot;:&quot;https://jBbhwtiSSPHUyPjCggextnLru.zgtgRc.U3B.IbX9DmX,zl&quot;,&quot;first&quot;:&quot;http://VOkPKJmCKypIyngpqUdruOcSGBFUM.xkjt&quot;,&quot;last&quot;:&quot;http://IBzjRReMYPtQkBDfWwSrfKIxA.mfr87,McxRkhg60VN&quot;,&quot;prev&quot;:&quot;http://ObaYGaCChtklENrRxkvf.mgqdtQ1V,HS++NTIAaQTf-xBBaxoFscP4rxjJUeQ3PEkPjGFJ2-IHZkdst,yf2Cj919vj9xOqazB&quot;,&quot;next&quot;:&quot;https://RmvfLdsEKgoeVWFcCqNbywZmCNcxaaq.oxNTH9uFF1DaJFucBkgIPCopJ64YeaDYOq0O2RhPPP2mQTS6cZhPdtPxG2.d111&quot;}}