Logo of linkbreakers

Tags

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

#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

GET
/v1/tags
Requires auth

#List tags

Search workspace tags by name and paginate through matching results.

#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

#Response

200

Everything worked as expected.

nextPageToken

string

Cursor to continue listing tags

tags

array<object>

The list of tags matching the search criteria

#Error response

400-599

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

error

object
Required

Wrapped error response.

DELETE
/v1/tags
Requires auth

#Delete tags

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

#Parameters

query parameters

name

string
Required
query

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

object
Required

Wrapped error response.