API DocsRESTTag service

ListTags

Retrieves tags using an optional filter.

GET
/api/v1/tags

Query Parameters

pageSizeinteger

The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 50 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListTags call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTags must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string Available fields to filter by are 'name' and 'tag_id'. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

namestring

Alias for filter. The web-client is unable to use filter so please use name for the code generated via RTK.

curl -X GET "<API_URL>/api/v1/tags?pageSize=0&pageToken=string&filter=string&name=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "tags": [
    {
      "tagId": "string",
      "name": "string",
      "organizationId": "string",
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string"
}