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