Get Segment Relationships Profiles
GET {{baseUrl}}/api/segments/:id/relationships/profiles/
Get all profile membership relationships for the given segment ID.
Rate limits:
Burst: 75/s
Steady: 700/m
Scopes:
profiles:read
segments:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>email: any, equals<br>phone_number: any, equals<br>push_token: any, equals<br>_kx: equals<br>joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | |
page[size] | number | Default: 20. Min: 1. Max: 1000. | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sorting |
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":"\u003cstring\u003e"},{"type":"profile","id":"\u003cstring\u003e"}]}