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

Autorisierungen

Authorizationstringheadererforderlich

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

Query-Parameter

sort_byenum<string> | nullquery

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

Verfügbare Optionen: name

sort_directionenum<string> | nullquery

Default is asc

Verfügbare Optionen: asc, desc

pageinteger | nullquery

Erforderlicher Bereich: 1 <= x

per_pageinteger | nullquery

Erforderlicher Bereich: 1 <= x <= 100

Antwort

Paginated set of TagResource

dataobject[]erforderlich

child attributes anzeigen

linksobjecterforderlich

child attributes anzeigen

metaobjecterforderlich

child attributes anzeigen

Brauchen Sie noch Hilfe? Team fragen