Retrieve a list of tags

Retrieve a list of tags for the authenticated workspace.

GET /tags

Python

Python

from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.tags.list(request={
        "page": 1,
        "page_size": 50,
    })

    # Handle response
    print(res)

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "color": "red"
  }
]

Authorizations

Authorization · string · header · required

Default authentication mechanism

Query Parameters

sortBy · enum<string> · default: name

The field to sort the tags by.

Available options: name, createdAt

sortOrder · enum<string> · default: asc

The order to sort the tags by.

Available options: asc, desc

search · string

The search term to filter the tags by.

ids · string string[]

IDs of tags to filter by.

page · number

The page number for pagination.

Required range: x > 0

Example:

1

pageSize · number · default: 100

The number of items per page.

Required range: 0 < x <= 100

Example:

50

Response

200

application/json

A list of tags

id · string · required

The unique ID of the tag.

name · string · required

The name of the tag.

color · enum<string> · required

The color of the tag.

Available options: red, yellow, green, blue, purple, brown, gray, pink