List private tags in an organisation

Endpoint

GET v1/organisations/{id}/private-tags

Response Codes

200 OK Successfully listed the private tags
403 Not Authorised You aren't allowed to list the private tags (not in that organisation)

Response Body

An array of private tags. See "Get a private tag" for the fields. Note that there won't be a number_of_articles or number_of_images field, which is only available when getting a particular private tag by ID.

Create a private tag in an organisation

Endpoint

POST v1/organisations/{id}/private-tags

Request Body

field required type description
name yes string The tag name
description no string The tag description

Example Request Body

{
    "name": "For Bob",
    "description": "For Bob to complete"
}

Response Codes

201 Created The private tag was created successfully
403 Not Authorised You aren't allowed to create the private tag

Response Body

The newly created private tag object. See "Get a private tag" for the fields.

Get a private tag

Endpoint