List Tags

GET/api/v1/tags

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Responses

200Successful Response

successboolean

default: true

dataCreativeTagWithUsage[] | any

Show properties

Any of:

CreativeTagWithUsage[]

Array of CreativeTagWithUsage

idstringrequired

slugstringrequired

labelstringrequired

statusTagStatusrequired

A creative tag's lifecycle. `PROPOSED` on first use (`Tags` field, coined free-form); an admin promotes it to `APPROVED` once it earns a place in the shared vocabulary, or retires it to `ARCHIVED`. The `slug` does not move across this — every creative that already carries it keeps carrying it, so promotion is a one-document status write. A *rename* is the one thing that does move it, because the slug is derived from the label; see `set_label`.

Allowed:proposedapprovedarchived

created_bystringrequired

created_atstring<date-time>required

updated_atstring<date-time>required

usage_countinteger

default: 0

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

Request

curl -X GET "/api/v1/tags" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/tags", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/tags",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": [
    {
      "id": "string",
      "slug": "string",
      "label": "string",
      "status": "proposed",
      "created_by": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "usage_count": 0
    }
  ],
  "message": "string",
  "errors": [
    "string"
  ]
}