Tags API

Find and create tags. To assign content to a tag, see Tag content. Before you start, read the API overview for how authentication, headers, pagination and errors work.

Create a tag

Create a new tag, optionally under a parent tag.

string

required

The name of the tag.

string

The name of the parent tag. The parent tag must already exist.

string

An external unique ID for the tag.

string

The URL that the tag links to.

Create a tag

curl -X POST "https://your-community.zapnito.com/api/v1/tags" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "tag": {
      "name": "Compliance",
      "external_url": "https://example.com/regulation/compliance",
      "external_id": "1221",
      "parent_name": "Regulation"
    }
  }'

POST https://your-community.zapnito.com/api/v1/tags

{
  "tag": {
    "name": "Compliance",
    "external_url": "https://example.com/regulation/compliance",
    "external_id": "1221",
    "parent_name": "Regulation"
  }
}

{
  "errors": {
    "message": "Tag named Compliance was not created because no parent tag already exists with name: Regulation"
  }
}

201 Created: the tag was created.
422 Unprocessable Entity: the tag wasn’t created. Either no parent tag matches parent_name, or a tag with that name already exists. In the second case the response is {"errors": {"name": "has already been taken"}}.

Return the existing tags.

string

Only return tags with this parent tag name.

List tags

curl "https://your-community.zapnito.com/api/v1/tags?parent_name=Regulation" \
  -H "Authorization: Token token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json; charset=utf-8"

GET https://your-community.zapnito.com/api/v1/tags

{
  "tags": [
    { "name": "Compliance", "external_url": "https://example.com/regulation/compliance", "external_id": "", "parent_name": "Regulation" },
    { "name": "Licensing", "external_url": "", "external_id": "", "parent_name": "Regulation" },
    { "name": "Reporting", "external_url": "", "external_id": "", "parent_name": "Regulation" },
    { "name": "Audit", "external_url": "", "external_id": "", "parent_name": "Regulation" }
  ]
}

Getting started

Users

Groups and organisations

Content

Channels and rooms

Badges

Create a tag

​Create a tag

​List tags

Create a tag

List tags