Qodex.ai

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

KeyDatatypeRequiredDescription
fields[segment]stringFor more information please visit https://developers.klaviyo.com/en/v2023-09-15/reference/api-overview#sparse-fieldsets

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Acceptstring

RESPONSES

status: OK

{"data":[{"type":"segment","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"data":[{"type":"profile","id":"\u003cstring\u003e"},{"type":"profile","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"segment","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","created":"\u003cdateTime\u003e","updated":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"profiles":{"data":[{"type":"profile","id":"\u003cstring\u003e"},{"type":"profile","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}