get all
Returns a list of designations you've previously created. The designations will be returned in descending order of when they were created, unless you specify otherwise.
For custom components:
RaiselyComponents.api.all('designations').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 by designation status. Defaults to 'ACTIVE'. Use 'ALL' to return both active and archived designations.
Filter designations by campaign UUID.
Headers
A valid HTTP Bearer token, required to access private records.
Response
The resulting collection of Designation records
Example response
{
"data": [
{
"createdAt": "2020-12-03T06:52:46.330Z",
"organisationId": 12345,
"publicName": "General Fund",
"status": "ACTIVE",
"updatedAt": "2020-12-03T06:52:46.330Z",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}