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.
You can adjust the number of results per page via the page[size] query parameter, e.g. ?page[size]=25. Default: 20. Max: 100.
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/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>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/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":"profile","id":"consectetu","attributes":{"email":"culpa deserunt consequat","phone_number":"labore repre","external_id":"consec","anonymous_id":"quis culpa","first_name":"commodo culpa eu dolor","last_name":"cillum id nulla","organization":"veniam irure deserunt dolore","title":"cupidatat ex non","image":"ut adipisicing sed ad nostrud","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","last_event_date":"2022-11-08T00:00:00","location":{"address1":"anim incididunt eiusmod adipisicing","address2":"Duis magna dolor eu","city":"irure deserunt enim Ut","country":"culpa id in qu","latitude":"deserunt eu dolor anim","longitude":"off","region":"commodo","zip":"deserunt veniam magna est","timezone":"minim Duis"},"properties":{}},"links":{"self":"http://dQGshAo.swqo3bSNGgV7pc35LHDqHPrvZPwV6T4zBvvJjSgGZ79LfpFgolPOsCA6S"}},{"type":"profile","id":"labore","attributes":{"email":"ullamco commodo et incididunt sed","phone_number":"esse eu sit incididunt","external_id":"aliqua quis non","anonymous_id":"ipsum ullamco irure ","first_name":"nulla amet","last_name":"nostrud velit et","organization":"est et ea","title":"in dolor","image":"et sint","created":"2022-11-08T00:00:00","updated":"2022-11-08T00:00:00","last_event_date":"2022-11-08T00:00:00","location":{"address1":"aliqua reprehenderit ut","address2":"magna elit","city":"eu sunt adipisicing Ut","country":"in deserunt Ut","latitude":"nisi consectetur ea sunt","longitude":"ea eu","region":"est","zip":"amet aliquip","timezone":"dolor in sed"},"properties":{}},"links":{"self":"http://BrrrDkQkYOmUgvN.jaDt7JcPfvWABLd51zqM5xr"}}],"links":{"self":"http://BqGsYjkDLazisrTfUcwiyXzdMn.xfkyQzFGLGAGyGtcmqjE","first":"http://ebWHxEyQqtTLCVGddsYGSYRBEC.ilxaxEtxUVTORUmK2WVvRZA7SLWyHIdZZLpAO","last":"http://D.mpkCdURsPz5f9u-Kf5yy5apXiecG,yRO8DZzwry7bpQS6r-I16.vIw4KGTu6zNQLjRRV","prev":"https://mvieMxgHGjGbAYwTqABbPUmkb.vnnbGUygpRrjbFznwPQeshvaZHsZk,H9rm","next":"http://JPzXdLPTckxbjuef.ydtqoq+gEMySCfc"}}