Tags

List all tags

Returns every tag defined in the caller's tenant, both active and inactive, as an unpaginated array (no particular order is guaranteed). The tenant is taken from the access token, never from the request.

Authorization: requires the global:user scope.

Results are cached per tenant and the cache is evicted whenever tags are updated or deleted, so changes are visible immediately.

get/tags

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/tags
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: global:user

Response

All tags of the caller's tenant (possibly empty).

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid

Tag ID

labelstring

Display label (1-255 characters)

activeboolean

Whether the tag is active (offered for selection)

Example response

[
  {
    "id": "3f6c2a1e-8b4d-4c7a-9e21-5d0b7f4a9c13",
    "label": "VIP customer",
    "active": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.