GET /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

Servers

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
Allowed field(s)/operator(s):
email: any, equals
phone_number: any, equals
push_token: any, equals
_kx: equals
joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than

sort String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#sorting

Possible values:

  • "joined_group_at"
  • "-joined_group_at"
pagesize Integer No

Default: 20. Min: 1. Max: 100.

Default value: 20

pagecursor String No

For more information please visit https://developers.klaviyo.com/en/v2025-04-15/reference/api-overview#pagination

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.