Get a tag

Contents

    Get a single tag, including the full details of every page that uses it. Heavier than Get all tags. Use that endpoint when you only need the tag list.

    Requires the API Token. See Authentication.

    HTTP Request

    GET /api/tags/{key}

    Parameters

    Key Type Description
    token (required) string API Token.

    Response

    HTTP Code: 200
    Content-Type: application/json
    Body:
    {
      "status": "0",
      "message": "Information about the tag and pages related.",
      "data": {
        "key": "bludit",
        "name": "Bludit",
        "description": "",
        "template": "",
        "list": ["follow-bludit"],
        "pages": [
          { "key": "follow-bludit", "title": "...", "...": "..." }
        ]
      }
    }

    list contains page keys; pages contains the same pages expanded into full page objects.

    Errors

    Code Reason
    404 No tag exists with the given key.

    CURL command example

    $ curl -X GET "https://www.example.com/api/tags/bludit?token=<api-token>"