Tag

A tag.

Get all tags

Get all tags of the authenticated hub.

SecurityJWT
Request
query Parameters
page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/tag
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "f7c6b689ca178876b63f4875583793cd10f63992",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1659543909845
}

Get a tag

Get a tag.

SecurityJWT
Request
path Parameters
tag
required
string or integer

The id/hash of the tag.

Responses
200

Successful operation

404

Not Found

get/tag/{tag}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "fb35225599e2db01ecf7b627d79de02f50012156",
  • "data": {
    },
  • "timestamp": 1657895194580
}

Update a tag

Update a tag.

SecurityJWT
Request
path Parameters
tag
required
string or integer

The id/hash of the tag.

Request Body schema: application/json

A JSON object containing tag information.

name
string <= 200 characters

The name of the tag.

color
string^[A-Za-z0-9]{6}$

The hex color code of the tag.

Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/tag/{tag}
Request samples
application/json
{
  • "name": "Netherlands",
  • "color": "FBAA00"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "a53973c66ee4c2cda1ea068f7d42f66d2e266d24",
  • "data": {
    },
  • "timestamp": 1659544946878
}

Delete a tag

Delete a tag.

SecurityJWT
Request
path Parameters
tag
required
string or integer

The id/hash of the tag.

Responses
200

Successful operation

404

Not Found

delete/tag/{tag}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659545313192
}

Restore a tag

Restore a tag.

SecurityJWT
Request
path Parameters
tag
required
string or integer

The id/hash of the tag.

Responses
200

Successful operation

404

Not Found

put/tag/{tag}/restore
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1659545424264
}

Merge tags

Merge multiple tags to a single tag.

If you want to merge the tags to an already existing tag, the tag name must be part of the tags array.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing tag information.

name
required
string <= 1000 characters

The name of the tag.

tags
required
Array of strings

The name of the tags which are merged.

Responses
200

Successful operation

422

Unprocessable Content

post/tag/merge
Request samples
application/json
{
  • "name": "Europe",
  • "tags": [
    ]
}
Response samples
application/json
{
  • "success": true,
  • "hash": "ca9548868aee978fd82fede86f8f00c846b2c18b",
  • "data": {
    },
  • "timestamp": 1659546489200
}