---
title: "Tags API Reference"
description: "Endpoints for managing tags in Linkbreakers. These endpoints allow you to search for tags in a workspace."
canonical: "https://linkbreakers.com/help/api/tags"
---

# Tags

Endpoints for managing tags in Linkbreakers. These endpoints allow you to search for tags in a workspace.

## Tags

## [#](#tags-object)The Tag object

Provides lightweight segmentation metadata Linkbreakers attaches to links and analytics so teams can group campaigns and filter dashboards.

createdAt

string (date-time)

When the tag was created

id

string

The unique identifier of the tag (UUID)

name

string

The name of the tag

updatedAt

string (date-time)

When the tag was last updated

[Learn moreLearn more about tags in Linkbreakers.](https://linkbreakers.com/help/article/what-is-a-tag)

Example object

```json
{
  "createdAt": "2026-10-22T01:31:10.992Z",
  "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
  "name": "string",
  "updatedAt": "2026-10-22T01:31:10.992Z"
}
```

GET

`/v1/tags`

Requires auth

## [#](#list-tags)List tags

Search workspace tags by name and paginate through matching results. Requires the \`links:read\` scope.

### [#](#list-tags-parameters)Parameters

#### query parameters

search

string

query

The search query to filter tags by name

pageSize

integer (int64)

Required

query

The maximum number of tags to return

pageToken

string

query

The token for retrieving the next page of results If not provided, the first page of results will be returned

cursor

string

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### [#](#list-tags-response)Response

200

Everything worked as expected.

nextPageToken

string

Cursor to continue listing tags

tags

array<object>

The list of tags matching the search criteria

### [#](#list-tags-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X GET "https://api.linkbreakers.com/v1/tags?search={search}&pageSize={pageSize}&pageToken={pageToken}&cursor={cursor}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{
  "nextPageToken": "eyJ0YWdJZCI6IjEwIn0=",
  "tags": [
    {
      "createdAt": "2026-10-22T01:31:10.992Z",
      "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
      "name": "string",
      "updatedAt": "2026-10-22T01:31:10.992Z"
    }
  ]
}
```

Base URL: `https://api.linkbreakers.com`

DELETE

`/v1/tags`

Requires auth

## [#](#delete-tags)Delete tags

Remove a tag by name so it no longer appears for links or analytics filters. Requires the \`links:write\` scope.

### [#](#delete-tags-parameters)Parameters

#### query parameters

name

string

Required

query

Tag name to remove (must exactly match an existing tag within the workspace)

### [#](#delete-tags-response)Response

200

Everything worked as expected.

No structured schema available for this section.

### [#](#delete-tags-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/tags?name={name}" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

Typical response

```json
{}
```

Base URL: `https://api.linkbreakers.com`

Cookies

We use cookies to measure our ads with Meta and Google. Our own analytics are cookie-free and run either way. [Privacy statement](https://linkbreakers.com/privacy#cookies)

---

Source: https://linkbreakers.com/help/api/tags