Tags

List Tags

get

Get tags according to query filters.

Args: tag_filter_model: Filter model used for pagination, sorting, filtering hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The tags according to query filters.

Authorizations

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

scope_userany ofOptional

string · uuidOptional

or

nullOptional

userany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

colorany ofOptional

string · enumOptional

All possible color variants for frontend.

Possible values:

or

nullOptional

exclusiveany ofOptional

booleanOptional

or

nullOptional

resource_typeany ofOptional

string · enumOptional

All possible resource types for tagging.

Possible values:

or

nullOptional

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/tags HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "color": "grey",
        "exclusive": true,
        "tagged_count": 1
      },
      "metadata": {},
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}

Create Tag

post

Create a new tag.

Args: tag: The tag to create.

Returns: The created tag.

Authorizations

Body

Request model for tags.

userany ofOptional

string · uuidOptional

or

nullOptional

namestring · max: 255Required

The unique title of the tag.

exclusivebooleanOptional

The flag signifying whether the tag is an exclusive tag.

Default: false

colorstring · enumOptional

The color variant assigned to the tag.

Possible values:

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/tags HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "exclusive": true,
  "color": "grey"
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "color": "grey",
    "exclusive": true,
    "tagged_count": 1
  },
  "metadata": {},
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Get Tag

get

Get a tag by name or ID.

Args: tag_name_or_id: The name or ID of the tag to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The tag with the given name or ID.

Authorizations

Path parameters

tag_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Query parameters

hydratebooleanOptionalDefault: true

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/tags/{tag_name_or_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "color": "grey",
    "exclusive": true,
    "tagged_count": 1
  },
  "metadata": {},
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Tag

delete

Delete a tag by name or ID.

Args: tag_name_or_id: The name or ID of the tag to delete.

Authorizations

Path parameters

tag_name_or_idany ofRequired

stringOptional

or

string · uuidOptional

Responses

Responseany

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/tags/{tag_name_or_id} HTTP/1.1
Host: 
Accept: */*

No content

Update Tag

put

Updates a tag.

Args: tag_id: Id or name of the tag. tag_update_model: Tag to use for the update.

Returns: The updated tag.

Authorizations

Path parameters

tag_idstring · uuidRequired

Body

Update model for tags.

nameany ofOptional

stringOptional

or

nullOptional

exclusiveany ofOptional

booleanOptional

or

nullOptional

colorany ofOptional

string · enumOptional

All possible color variants for frontend.

Possible values:

or

nullOptional

Responses

put

HTTPcURLJavaScriptPython

PUT /api/v1/tags/{tag_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": "text",
  "exclusive": true,
  "color": "grey"
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    },
    "color": "grey",
    "exclusive": true,
    "tagged_count": 1
  },
  "metadata": {},
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}