Get Tag Groups
GET {{baseUrl}}/api/tag-groups/
List all tag groups in an account. Every account has one default tag group.
Tag groups can be filtered by name
, exclusive
, and default
, and sorted by name
or id
in ascending or descending order.
Returns a maximum of 25 tag groups per request, which can be paginated with
cursor-based pagination.
Rate limits:
Burst: 3/s
Steady: 60/m
Scopes:
tags:read
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fields[tag-group] | string | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#sparse-fieldsets | |
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>name : contains , ends-with , equals , starts-with <br>exclusive : equals <br>default : equals | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2024-06-15/reference/api-overview#pagination | |
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":"tag-group","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","exclusive":"\u003cboolean\u003e","default":"\u003cboolean\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"tags":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"tag-group","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","exclusive":"\u003cboolean\u003e","default":"\u003cboolean\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"tags":{"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}