GET/projects/api/v3/tags.json

Get all tags

Return all tags that the logged-in user can access.

Query Params

  • Name
    updatedAfter
    Type
    string
    Description
    search for tags updated after the provided date
  • Name
    searchTerm
    Type
    string
    Description
    filter by search term
  • Name
    orderMode
    Type
    string
    Description
    order mode
    Default
    asc
  • Name
    orderBy
    Type
    string
    Description
    order by
    Default
    name
  • Name
    itemType
    Type
    string
    Description
    filter by item type
    Default
    all
  • Name
    filter
    Type
    string
    Description
    mode used when filtering the tags
    Default
    all
  • Name
    pageSize
    Type
    integer
    Description
    number of items in a page
    Default
    500
  • Name
    page
    Type
    integer
    Description
    page number
    Default
    1
  • Name
    withCounters
    Type
    boolean
    Description
    include in the response the number of items that use the tag
    Default
    false
  • Name
    skipSpecial
    Type
    boolean
    Description
    do not include in the response special tags
    Default
    true
  • Name
    skipCounts
    Type
    boolean
    Description
    SkipCounts allows you to skip doing counts on a list API endpoint for
    performance reasons.
  • Name
    searchRightOnly
    Type
    boolean
    Description
    search term will be placed as a prefix to match the tag names
    Default
    false
  • Name
    skipIds
    Type
    array[integer]
    Description
    skip from the result tags with the defined ids
    Format
    Comma separated values
  • Name
    projectIds
    Type
    array[integer]
    Description
    filter by projects
    Format
    Comma separated values
  • Name
    ids
    Type
    array[integer]
    Description
    filter by ids
    Format
    Comma separated values
  • Name
    fields[tags]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • color
    • count

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    TagsResponse contains information about a group of tags.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

TagsResponse
{  "included": {    "cards": {      "additionalProp": {        "archived": true,        "archivedAt": "string",        "archivedBy": {          "id": 0,          "meta": {},          "type": "string"        },        "column": {          "id": 0,          "meta": {},          "type": "string"        },        "createBy": {          "id": 0,