get all
Retrieve the list of tags. NOTE Unlike other endpoints, any tags flagged as private will not be present unless the request includes private=1
For custom components:
RaiselyComponents.api.all('tags').get(params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
Query parameters
Returns the full record when authenticated
Search query to find records matching
The number of records to limit per page
The pagination offset (in number of records)
The record attribute to filter on (use in conjunction with order)
The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending
Filter Tag based on their recordType value
Filter Tag based on their path value
Headers
A valid HTTP Bearer token, required to access private records.
Response
A list of tags
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"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}