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/v2023-01-24/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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/v2023-01-24/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-01-24/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":"zyxw9876-vu54-ts32-rq10-zyxwvu654321","attributes":{"name":"My Tag Group","exclusive":false,"default":false},"links":{"self":"http://JAmLCFaeQqCuLZJJNYlnDGZy.skxjz"}},{"type":"tag-group","id":"zyxw9876-vu54-ts32-rq10-zyxwvu654321","attributes":{"name":"My Tag Group","exclusive":true,"default":false},"links":{"self":"http://YNEftuiyqAcInmJbXgKn.rynoj-mW4vexmg0rOqCzHHuRuogoMIb0WoT4lUZV1D-9qWjoGwkyg5S3Y-hdaRxp.z3UIQ+."}}],"links":{"self":"https://NxImvzMZvxtW.yqjj7,I+e1e+ZByXpDSlpyBv4bH0","first":"https://knoKNwPOJpXSJmLcZIQb.xmdbTHk8wK9q056FJZs+FCybEVjicfSkW--yq.mg.+ZeL4fFRzhQRWPONkVilszX94wdp5NVM","last":"http://EaHEbK.jhuph8aYKyTd+z0W-OJYED5lWlLLQnPt3udn4EH6mpz8qAEBcy7+PH5wfivLkkwKkIm0vULo","prev":"http://LtGACOIayLvOCf.uoqkNvYocWPWmbxwYt+kqUo.DVS6nHLscFvHZByjn-AAw","next":"https://nfPiGBLPaGNhRgDuHfOMWrBCw.tdrWX1x0Z8fp2-gyeyp3XWVLXvN2sMDewWQQRsser.J-xVKXkuDYnHniY61flzV"}}