The following macros are not currently supported in the header:
  • style

List Tags

Resource URL

Returns an array of tags.

GET /tags

Parameters

Table of allowed parameters.

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page.
_searchstringSearch for tags using a query string.
_filterspartial stringFilter tags

Filtering expense

You can filter the returned list using the _filters parameter. You can stack filters. For example,_filters=id(21,3),title(javascript)

 

Name
Example
Description
id(...) or id_not(...)_filters=id(12,3)Only return tags with or without given id(s).
title(...) or title_not(...)_filters=title(javascript)Only return tags with or without given title(s).
against(type1(...),typeN(...))_filters=against(job(1,4), issue(2,4))Only return tags with the matching against values. The example will only return tags against job 1 and 4 or tags against issue 1 and 4.

Handling the response

The tag response will always return the tag id and title.

Sample
{
  "response": {
    "tags": [
      {
        "id": "20",
        "title": "Perl"
      },
      {
        "title": "Javscript",
        "id": "18"
      },
      {
        "title": "C++",
        "id": "9"
      },
      {
        "title": "Android",
        "id": "7"
      }
    ]
  },
  "meta": {
    "status": "ok",
    "message": "Everything executed as expected.",
    "more_info": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok"
  }
}