curl --request GET \
--url https://{organization}.rescueconsole.com/api/people/persons \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/people/persons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/people/persons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"roles": [
"adopter"
],
"address": {
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>"
},
"status": "active",
"preferred_contact": [
"email"
],
"custom_fields": {},
"id": "<string>",
"display_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name_prefix": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"name_suffix": "<string>",
"email": "<string>",
"phone": "<string>",
"phone_country": "<string>",
"date_of_birth": "2023-12-25",
"tenant_id": "<string>",
"photo_file_id": "<string>",
"avatar_key": "<string>",
"tags": [
"<string>"
]
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}List people
One page of your people, newest first unless you say otherwise. Deleted people are never included; archived ones are, unless you filter by status. The same filters work on the counts, the export and a bulk change. Text filters match when the field contains what you send. To filter on a custom field, send cf_ and its field key, such as cf_home_type=Apartment. A true-or-false field takes yes or no, a number field takes one exact number, and every other kind matches when its value contains what you send. List person filters shows which custom fields can be used; any other is refused. Needs read on People.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/people/persons \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/people/persons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/people/persons"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"roles": [
"adopter"
],
"address": {
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>"
},
"status": "active",
"preferred_contact": [
"email"
],
"custom_fields": {},
"id": "<string>",
"display_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name_prefix": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"name_suffix": "<string>",
"email": "<string>",
"phone": "<string>",
"phone_country": "<string>",
"date_of_birth": "2023-12-25",
"tenant_id": "<string>",
"photo_file_id": "<string>",
"avatar_key": "<string>",
"tags": [
"<string>"
]
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
How many to return. 25 unless you say, 100 at most.
1 <= x <= 100How many to skip, for the next page.
x >= 0display_name, first_name, last_name, email, status, created_at, updated_at asc, desc People whose first name, last name or email contains this.
People who hold this role.
adopter, donor, volunteer, foster People with this status: active, inactive or archived. Any other value matches nobody.
People carrying this tag. Several tags separated by commas match a person carrying any of them.
The full name contains this.
The first name contains this.
The last name contains this.
The email address contains this.
The phone number contains these digits. Phone numbers are kept as digits only.
Added on or after this date or time.
Added on or before this. It is compared with the full time, so a bare date here means the very start of that day.
Last changed on or after this date or time.
Last changed on or before this. It is compared with the full time, so a bare date here means the very start of that day.