Return a tag by id.

GET

/api/workspace/tags/{tagId}

curl --request GET \
  --url https://example.com/api/workspace/tags/example

Authorizations

• None

Parameters

Path Parameters

tagId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

Tag details.

object

Id

Tag identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creator identifier, or null for legacy rows without attribution.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

code

string

nullable

field

string

nullable

metadata

object

key

additional properties

string

nullable

correlationId

required

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example",
  "field": "example",
  "metadata": {
    "additionalProperty": "example"
  },
  "correlationId": "example"
}

404

Not Found

Media typeapplication/json

object

Data

Tag details.

object

Id

Tag identifier.

string

nullable

Owner

object

ModuleKey

string

nullable

ResourceKind

string

nullable

ContextResourceId

string

nullable

ResourceObjectId

string

nullable

TagName

Tag name.

string

nullable

Color

Optional color value.

string

nullable

Category

Optional category.

string

nullable

CreatedAt

Creation timestamp.

string format: date-time

CreatedByUserId

Creator identifier, or null for legacy rows without attribution.

string

nullable

CreatedByUserName

Creator display name.

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}