Get the housing board
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/locations/board \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/locations/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/locations/board"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"unit_type": "campus",
"name": "<string>",
"capacity": 123,
"combined_with": [
"<string>"
],
"status": "active",
"effective_capacity": 123,
"effective_occupants": 123,
"animals": [
{
"id": "<string>",
"species": "<string>",
"status": "<string>",
"name": "<string>",
"photo_file_id": "<string>"
}
],
"parent_id": "<string>",
"is_virtual": true,
"foster_person_id": "<string>",
"org_location_id": "<string>",
"sort_order": 123,
"custom_fields": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"truncated": true,
"unplaced": [
{
"id": "<string>",
"species": "<string>",
"status": "<string>",
"name": "<string>",
"photo_file_id": "<string>"
}
]
}{
"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)"
}Locations and housing
Get the housing board
Every place in your buildings, with the animals in care in each: campuses, buildings, rooms and cages. It is one flat list, by each unit’s place among its neighbours and then by name; build the tree from parent_id. Foster homes and virtual placements are not on it. Retired units are left out unless you ask for them. At most 2,000 units come back; truncated says whether there were more. Needs read on Animals.
GET
/
api
/
animals
/
locations
/
board
Get the housing board
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/locations/board \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/locations/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/locations/board"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"unit_type": "campus",
"name": "<string>",
"capacity": 123,
"combined_with": [
"<string>"
],
"status": "active",
"effective_capacity": 123,
"effective_occupants": 123,
"animals": [
{
"id": "<string>",
"species": "<string>",
"status": "<string>",
"name": "<string>",
"photo_file_id": "<string>"
}
],
"parent_id": "<string>",
"is_virtual": true,
"foster_person_id": "<string>",
"org_location_id": "<string>",
"sort_order": 123,
"custom_fields": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"truncated": true,
"unplaced": [
{
"id": "<string>",
"species": "<string>",
"status": "<string>",
"name": "<string>",
"photo_file_id": "<string>"
}
]
}{
"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
One unit and everything inside it, at any depth, instead of everything.
true to include retired units.