v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Tags

all records

Get all Raisely records that are assigned the provided Tag

For custom components:

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

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

get/tags/{uuid}/records

Path parameters

uuidstring required

The uuid of the record

Query parameters

privateboolean

Returns the full record when authenticated

qstring

Search query to find records matching

limitnumber

The number of records to limit per page

offsetnumber

The pagination offset (in number of records)

sortstring

The record attribute to filter on (use in conjunction with order)

order'asc' | 'desc'

The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending

Headers

Authorizationstring

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

Response

A paginated response with the matching records

Example response

{
  "data": [
    {
      "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "tags": [
        {
          "color": "#ff0000",
          "createdAt": "2020-12-03T06:52:46.330Z",
          "internal": {},
          "isPrivate": true,
          "label": "My Custom Tag",
          "organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
          "path": "example-path",
          "recordType": "user",
          "updatedAt": "2020-12-03T06:52:46.330Z",
          "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        }
      ]
    }
  ],
  "pagination": {
    "total": 10,
    "pages": 2,
    "offset": 5,
    "limit": 5
  }
}