GET /api/segments/{id}/profiles
Get all profiles within a segment with the given segment ID.
Filter to request a subset of all profiles. Profiles can be filtered by email, phone_number, push_token, and joined_group_at fields. Profiles can be sorted by the following fields, in ascending and descending order: joined_group_at
Rate limits:
Burst: 75/s
Steady: 700/m
Scopes:
profiles:read
segments:read
Servers
- https://a.klaviyo.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
Primary key that uniquely identifies this segment. Generated by Klaviyo. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
revision |
String | Yes |
API endpoint revision (format: YYYY-MM-DD[.suffix]) Default value: "2025-04-15" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
String | No |
For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#filtering |
sort |
String | No |
For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting Possible values:
|
fieldsprofile[] |
Array | No |
For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sparse-fieldsets |
pagesize |
Integer | No |
Default: 20. Min: 1. Max: 100. Default value: 20 |
additional-fieldsprofile[] |
Array | No |
Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' |
pagecursor |
String | No |
For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.