Tags

Get All Tags

get

Get all tags

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idFilterany ofOptional

Comma-separated tag IDs to filter by

anyOptional

or

string[]Optional

nameFilterany ofOptional

Comma-separated tag names to filter by

anyOptional

or

string[]Optional

takeany ofOptionalDefault: 10

anyOptional

or

numberOptional

skipany ofOptionalDefault: 0

anyOptional

or

numberOptional

sortFieldstring · enumOptional

Field to sort by

Possible values:

sortOrderstring · enumOptional

Sort order for the selected field

Possible values:

Responses

200

Successful response

application/json

default

Error response

application/json

get

/tags

HTTPcURLJavaScriptPython

GET /api/tags HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tags": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Create Tag

post

Create Tag

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

ID value. Only alphanumeric, underscore, and hyphen are allowed.

Pattern: ^[a-zA-Z0-9_-]+$

namestringRequired

descriptionstringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

post

/tags

HTTPcURLJavaScriptPython

POST /api/tags HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "id": "text",
  "name": "text",
  "description": "text"
}

{
  "createdTag": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Delete Tags

delete

Delete one or more Tags by their IDs

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idstring[]Optional

Responses

200

Successful response

application/json

default

Error response

application/json

delete

/tags

HTTPcURLJavaScriptPython

DELETE /api/tags HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deletedCount": 1
}

Get Tag Count

get

Get Tag Count

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idFilterany ofOptional

Comma-separated tag IDs to filter by

anyOptional

or

string[]Optional

nameFilterany ofOptional

Comma-separated tag names to filter by

anyOptional

or

string[]Optional

Responses

200

Successful response

application/json

default

Error response

application/json

get

/tags/count

HTTPcURLJavaScriptPython

GET /api/tags/count HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Get Tag by ID

get

Get a Tag by its ID.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID value. Only alphanumeric, underscore, and hyphen are allowed.

Pattern: ^[a-zA-Z0-9_-]+$

Responses

200

Successful response

application/json

default

Error response

application/json

get

/tags/{id}

HTTPcURLJavaScriptPython

GET /api/tags/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tag": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "text",
    "updatedAt": "text"
  }
}

Update Tag by ID

put

Update a Tag by its ID

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID value. Only alphanumeric, underscore, and hyphen are allowed.

Pattern: ^[a-zA-Z0-9_-]+$

Body

application/json

Responses

200

Successful response

application/json

default

Error response

application/json

put

/tags/{id}

HTTPcURLJavaScriptPython

PUT /api/tags/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "data": {
    "id": "text",
    "name": "text",
    "description": "text",
    "addGameObjects": [
      "text"
    ],
    "removeGameObjects": [
      "text"
    ]
  }
}

{
  "updatedTag": {
    "id": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "name": "text",
    "description": "text",
    "gameObjectCount": 1
  }
}