Tags API Reference

#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 more

Learn more about tags in Linkbreakers.

Example object

{
  "createdAt": "2025-10-29T08:00:04.657Z",
  "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
  "name": "string",
  "updatedAt": "2025-10-29T08:00:04.657Z"
}

GET/v1/tagsRequires auth

Search workspace tags by name and paginate through matching results.

query parameters

search

stringquery

The search query to filter tags by name

pageSize

integer (int32)Requiredquery

The maximum number of tags to return

pageToken

stringquery

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

200

Everything worked as expected.

nextPageToken

string

Cursor to continue listing tags

tags

array<object>

The list of tags matching the search criteria

400-599

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

error

objectRequired

Wrapped error response.

Example request (cURL)

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

Typical response

{
  "nextPageToken": "eyJ0YWdJZCI6IjEwIn0=",
  "tags": [
    {
      "createdAt": "2025-10-29T08:00:04.657Z",
      "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
      "name": "string",
      "updatedAt": "2025-10-29T08:00:04.657Z"
    }
  ]
}

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

DELETE/v1/tagsRequires auth

#Delete tags

Remove a tag by name so it no longer appears for links or analytics filters.

#Parameters

query parameters

name

stringRequiredquery

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

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

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

error

objectRequired

Wrapped error response.

Tags

#The Tag object

#List tags

#Parameters

query parameters

#Response

#Error response

#Delete tags

#Parameters

query parameters

#Response

#Error response