Skip to main content
GET
/
tags
/
{id}
Get tag by ID
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/tags/{id} \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "value": "<string>",
  "config": {
    "filtering": [
      "achievement"
    ],
    "display": [
      "achievement"
    ],
    "iconifyIcon": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the tag in. If not provided, the default language for the organisation will be used.

Path Parameters

​
id
string
required

The ID of the tag to retrieve

Response

Successful response

A tag

​
id
string
required

The id of the tag

Pattern: ^[0-9a-fA-F]{24}$
​
organisationId
string
required

The id of the organisation the tag belongs to

Pattern: ^[0-9a-fA-F]{24}$
​
value
string
required

The value of the tag

Minimum string length: 1
​
config
TagConfig · object
required

The configuration of a tag

​
createdAt
string
required

The date the tag was created

​
updatedAt
string
required

The date the tag was last updated

​
createdBy
string
required

The id of the user who created the tag

Pattern: ^[0-9a-fA-F]{24}$
​
updatedBy
string
required

The id of the user who last updated the tag

Pattern: ^[0-9a-fA-F]{24}$