Account

List tags

<small>Requires an API token with one of the following roles: Document Reader, Template Reader, or Tag Manager.</small>

GET

/tags

List tags

curl --request GET \
  --url 'https://app.fynk.com/v1/api/tags?sort_by=name&sort_direction=asc&page=123&per_page=123' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "color": "#615fff",
      "name": "Warranty",
      "uuid": "58ac52bb-8885-4580-88c1-7a7bc772c87d"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "links": [
      {
        "active": true,
        "label": "<string>",
        "url": "<string>"
      }
    ],
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

Lists the tags defined for your account.

Tags are simple labels that can be assigned to documents and templates.

Sorting

To specify the order that tags should be returned in, use the sort_by and sort_direction query string parameters.

For example, to sort by the name attribute in descending order, the query string should contain: sort_by=name&sort_direction=desc

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort_byenum<string> | nullquery

Name of the field to sort the response by. Default is name

Available options: name

sort_directionenum<string> | nullquery

Default is asc

Available options: asc, desc

pageinteger | nullquery

Required range: 1 <= x

per_pageinteger | nullquery

Required range: 1 <= x <= 100

Response

Paginated set of TagResource

dataobject[]required

Show child attributes

linksobjectrequired

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Share an idea