Designations
all designations
Returns designations associated with a campaign, ordered by sortOrder.
For custom components:
RaiselyComponents.api.one('campaigns', '{campaign}').get('designations', params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
get/campaigns/{campaign}/designations
Path parameters
campaignstring required
Campaign UUID
Query parameters
privateboolean
Returns the full record when authenticated
Headers
Authorizationstring
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
}
}