Get Tags
GET {{baseUrl}}/api/tags/
List all tags in an account.
Tags can be filtered by name, and sorted by name or id in ascending or descending order.
Returns a maximum of 50 tags 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-10-15/reference/api-overview#sparse-fieldsets | |
fields[tag] | string | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#sparse-fieldsets | |
filter | string | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>name: contains, ends-with, equals, starts-with | |
include | string | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#relationships | |
page[cursor] | string | For more information please visit https://developers.klaviyo.com/en/v2023-10-15/reference/api-overview#pagination | |
sort | string | For more information please visit https://developers.klaviyo.com/en/v2023-10-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","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"tag-group":{"data":{"type":"tag-group","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"lists":{"data":[{"type":"list","id":"\u003cstring\u003e"},{"type":"list","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"segments":{"data":[{"type":"segment","id":"\u003cstring\u003e"},{"type":"segment","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"campaigns":{"data":[{"type":"campaign","id":"\u003cstring\u003e"},{"type":"campaign","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"flows":{"data":[{"type":"flow","id":"\u003cstring\u003e"},{"type":"flow","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}},{"type":"tag","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"tag-group":{"data":{"type":"tag-group","id":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"lists":{"data":[{"type":"list","id":"\u003cstring\u003e"},{"type":"list","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"segments":{"data":[{"type":"segment","id":"\u003cstring\u003e"},{"type":"segment","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"campaigns":{"data":[{"type":"campaign","id":"\u003cstring\u003e"},{"type":"campaign","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"flows":{"data":[{"type":"flow","id":"\u003cstring\u003e"},{"type":"flow","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"},"included":[{"type":"tag-group","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","exclusive":"\u003cboolean\u003e","default":"\u003cboolean\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"tag-group","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","exclusive":"\u003cboolean\u003e","default":"\u003cboolean\u003e"},"links":{"self":"\u003curi\u003e"}}]}