Get Profile Segments
GET {{baseUrl}}/api/profiles/:id/segments/
Get segment memberships for a profile with the given profile ID.
Rate limits:
Burst: 3/s
Steady: 60/m
Scopes:
profiles:read
segments:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields[segment] | string | For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"segment","id":"\u003cstring\u003e","attributes":{"is_active":"\u003cboolean\u003e","is_processing":"\u003cboolean\u003e","is_starred":"\u003cboolean\u003e","name":"\u003cstring\u003e","definition":{"condition_groups":[{"conditions":[{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}},{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}}]},{"conditions":[{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}},{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"before","date":"\u003cdateTime\u003e"}}]}]},"created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"segment","id":"\u003cstring\u003e","attributes":{"is_active":"\u003cboolean\u003e","is_processing":"\u003cboolean\u003e","is_starred":"\u003cboolean\u003e","name":"\u003cstring\u003e","definition":{"condition_groups":[{"conditions":[{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}},{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}}]},{"conditions":[{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}},{"type":"profile-group-membership","is_member":true,"group_ids":["\u003cstring\u003e","\u003cstring\u003e"],"timeframe_filter":{"type":"date","operator":"after","date":"\u003cdateTime\u003e"}}]}]},"created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}