List tags

v1.0.0

Retrieve a list of all tags currently in use. The returned list is and can be scrolled by following the next and prev links where present. Results are ordered lexicographically. The transactions relationship for each tag exposes a link to get the transactions with the given tag.

Input

{
  "type": "object",
  "properties": {
    "page[size]": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Successful response to get all tags. This returns a paginated list of\ntags, which can be scrolled by following the `prev` and `next` links if\npresent.\n",
  "required": [
    "data",
    "links"
  ],
  "properties": {
    "data": {
      "type": "array",
      "description": "The list of tags returned in this response.\n",
      "items": {
        "type": "object",
        "description": "Provides information about a tag.\n",
        "required": [
          "type",
          "id",
          "relationships"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The label of the tag, which also acts as the tag’s unique identifier.\n"
          },
          "relationships": {
            "type": "object",
            "required": [
              "transactions"
            ],
            "properties": {
              "transactions": {
                "type": "object",
                "properties": {
                  "links": {
                    "type": "object",
                    "required": [
                      "related"
                    ],
                    "properties": {
                      "related": {
                        "type": "string",
                        "description": "The link to retrieve the related resource(s) in this relationship.\n"
                      }
                    }
                  }
                }
              }
            }
          },
          "type": {
            "type": "string",
            "description": "The type of this resource: `tags`"
          }
        }
      }
    },
    "links": {
      "type": "object",
      "required": [
        "next",
        "prev"
      ],
      "properties": {
        "next": {
          "type": "string",
          "description": "The link to the next page in the results. If this value is `null`\nthere is no next page.\n"
        },
        "prev": {
          "type": "string",
          "description": "The link to the previous page in the results. If this value is `null`\nthere is no previous page.\n"
        }
      }
    }
  }
}