v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Tags

get tag

Retrieve a specific tag.

For custom components:

RaiselyComponents.api.one('tags', '{uuid}').get('{uuid}', params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/tags/{uuid}

Path parameters

uuidstring required

The uuid of the record

Query parameters

privateboolean

Returns the full record when authenticated

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The resulting Tag record

Example response

{
  "data": {
    "color": "#ff0000",
    "createdAt": "2020-12-03T06:52:46.330Z",
    "internal": {},
    "isPrivate": true,
    "label": "My Custom Tag",
    "path": "example-path",
    "recordType": "user",
    "updatedAt": "2020-12-03T06:52:46.330Z",
    "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}