Tags

List tags

GEThttps://example.thoughtindustries.com/incoming/v2/tags

Returns a paginated list of tags, optionally filtered by the provided criteria.

Example request

curl "https://example.thoughtindustries.com/incoming/v2/tags" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`filters`	`TagsFiltersInput`	No	query	Filters to narrow the returned tags, such as by label or folder status.

Example response

{
  "data": {
    "Tags": {
      "pageInfo": {
        "perPage": 0,
        "currentPage": 0,
        "total": 0,
        "hasMore": true
      },
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "label": "string",
          "isFolder": true,
          "updatedAt": "2024-01-01T00:00:00.000Z",
          "description": "string"
        }
      ]
    }
  }
}

Response fields

Field	Type	Description
`pageInfo`	`PageInfo`	Pagination metadata for the result set.
`pageInfo.perPage`	`integer`	Number of tags returned per page.
`pageInfo.currentPage`	`integer`	Index of the current page in the result set.
`pageInfo.total`	`integer`	Total number of tags matching the request.
`pageInfo.hasMore`	`boolean`	Indicates whether additional pages of results are available.
`tags`	`Tag[]`	Array of tag objects matching the request.
`tags.id`	`uuid`	Unique identifier for the tag.
`tags.label`	`string`	Display name of the tag.
`tags.isFolder`	`boolean`	Indicates whether the tag acts as a folder grouping other tags.
`tags.updatedAt`	`ISO 8601 timestamp`	Date and time the tag was last modified, in ISO 8601 format.
`tags.description`	`string`	Optional text describing the purpose or contents of the tag.