get all
Returns a list of users you've previously created. The users will be returned in descending order of when they were created, unless you specify otherwise.
For custom components:
RaiselyComponents.api.all('users').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 User based on their postcode value
Filter User based on their country value
Filter User based on their facebookId value
Filter User based on their email value
Filter User based on their fullName value
Filter User based on their phone_number value
Filter by organisation uuid
Headers
A valid HTTP Bearer token, required to access private records.
Response
The resulting collection of User records
Example response
{
"data": [
{
"accessToken": "aaabbbccc",
"address1": "31 Sunset Boulevard",
"address2": "Unit 31b",
"adminSettings": {
"v4BetaOptin": true,
"starredCampaigns": [
"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
]
},
"country": "AU",
"createdAt": "2020-12-03T06:52:46.330Z",
"email": "harveymilk@example.com",
"facebookId": "fb_someurl",
"firstName": "Leila",
"fullName": "Leila Norma de Lima",
"internal": {},
"isAdmin": true,
"isSamlLogin": true,
"lastName": "de Lima",
"organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"permission": "PARTICIPANT",
"phoneNumber": "+1 123-456-7890",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"postcode": "AAA BBBB",
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"state": "Victoria",
"status": "ACTIVE",
"suburb": "Melbourne",
"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"
}
],
"unsubscribedAt": "2020-12-03T06:52:46.330Z",
"updatedAt": "2020-12-03T06:52:46.330Z",
"username": "harveymilk@example.com",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}