Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tags

List project tags

get

Returns tags for the selected project with test and suite usage counts.

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
projectIdstring · uuidOptional

Project ID. Required for organization and user API tokens.

Responses
200Success
application/json
colorstringRead-onlyRequired
idstring · uuidRead-onlyRequired
namestringRead-onlyRequired
suitesCountintegerRead-onlyRequired
testsCountintegerRead-onlyRequired
get/api/v2/tags/
GET /api/v2/tags/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "color": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "suitesCount": 1,
    "testsCount": 1
  }
]

Create project tag

post
Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters
projectIdstring · uuidOptional

Project ID. Required for organization and user API tokens.

Body
namestring · max: 64Required

Tag names cannot contain commas or control characters.

colorstring · max: 7OptionalPattern: ^#[0-9A-Fa-f]{6}$
Responses
201Success
application/json
colorstringRead-onlyRequired
idstring · uuidRead-onlyRequired
namestringRead-onlyRequired
post/api/v2/tags/
POST /api/v2/tags/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 30

"name='text'&color='text'"
{
  "color": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Retrieve project tag

get
Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idstring · uuidRequired

A UUID string identifying this tag.

Query parameters
projectIdstring · uuidOptional

Project ID. Required for organization and user API tokens.

Responses
200Success
application/json
colorstringRead-onlyRequired
idstring · uuidRead-onlyRequired
namestringRead-onlyRequired
get/api/v2/tags/{id}/
GET /api/v2/tags/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*
{
  "color": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Delete project tag

delete

Deletes the tag and all of its assignments.

Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idstring · uuidRequired

A UUID string identifying this tag.

Query parameters
projectIdstring · uuidOptional

Project ID. Required for organization and user API tokens.

Responses
204

No response body

No content

delete/api/v2/tags/{id}/
DELETE /api/v2/tags/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Update project tag

patch
Authorizations
AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters
idstring · uuidRequired

A UUID string identifying this tag.

Query parameters
projectIdstring · uuidOptional

Project ID. Required for organization and user API tokens.

Body
namestring · max: 64Optional

Tag names cannot contain commas or control characters.

colorstring · max: 7OptionalPattern: ^#[0-9A-Fa-f]{6}$
Responses
200Success
application/json
colorstringRead-onlyRequired
idstring · uuidRead-onlyRequired
namestringRead-onlyRequired
patch/api/v2/tags/{id}/
PATCH /api/v2/tags/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 30

"name='text'&color='text'"
{
  "color": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Last updated

Was this helpful?