Manage tags
Tags help you organize your Riddles – and they are the most reliable way to find Riddles again programmatically, as you can filter the Riddle list by tag IDs.
List all tags
To get all tags and their occurrence counts, use the /tag/list API endpoint.
| Property | Required | Type | Description |
|---|---|---|---|
project | integer|null | The project ID you want to get the tags from; pass NULL to explicitly get the user's tags; if nothing is sent, the project of the API key is used |
Get the tags of a Riddle
To get all tags of a single Riddle, use the /tag/riddle/list/{UUID} endpoint with the Riddle's UUID.
Add a tag to a Riddle
To tag a Riddle, use the /tag/riddle/{UUID} endpoint. Send either name or id:
| Property | Required | Type | Description |
|---|---|---|---|
name | (one of the two) | string | Creates a new tag with the given name and attaches it to the Riddle |
id | (one of the two) | integer | Attaches an already existing tag to the Riddle |
Example: Create and attach a new tag:
{
"name": "summer-campaign"
}
Remove a tag from a Riddle
To remove a tag from a Riddle, use the /tag/riddle/{UUID}/{tag} DELETE endpoint, where tag is the tag ID. The endpoint returns the serialized Riddle with its remaining tags, or HTTP 404 if the given tag + Riddle combination could not be found.