Tags

List tags

Returns every tag belonging to the active project. The response is paginated. Every new project is seeded with branded, non-branded, and review tags.

GET /api/v1/tags

Query parameters

Name Type Required Description
page integer Optional

The page number to return. Defaults to 1.
per_page integer Optional

The number of items per page. Defaults to 25, maximum 100.
sort_by string Optional

The column to sort by. Defaults to created_at.
sort_order string Optional

The direction to sort by. Each endpoint has its own default.
include string Optional

A comma-separated list of related resources to include in the response. Allowed values: project, project.organization.

Response

Response schema

Field Type Description
data Tag[]
links PaginationLinks
meta PaginationMeta

The tag object

Field Type Description
id integer

The unique ID of the tag.
project_id integer

The ID of the project this tag belongs to.
name string

The display label of the tag.
color string

The tag's color. One of gray, red, orange, amber, green, teal, blue, indigo, violet, or pink.
created_at datetime

When the tag was created.
updated_at datetime

When the tag was last updated.