Interaction Categories
get all
Returns all of the interaction categories in the organisation
For custom components:
RaiselyComponents.api.all('interaction_categories').get(params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
get/interaction_categories
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
The resulting collection of Interaction Category records
Example response
{
"data": [
{
"createdAt": "2020-12-03T06:52:46.330Z",
"fields": [
{
"active": true,
"config": {},
"createdAt": "2020-12-03T06:52:46.330Z",
"default": "anything",
"description": "This is the field description",
"label": "Example Label",
"locked": true,
"name": "fieldName",
"options": {
"key1": "Label 1"
},
"placeholder": "Field Placeholder",
"recordType": "user",
"sortOrder": 12345,
"type": "text",
"updatedAt": "2020-12-03T06:52:46.330Z",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"visible": true
}
],
"isCore": true,
"path": "example-path",
"priority": 12345,
"updatedAt": "2020-12-03T06:52:46.330Z",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}