List housing units
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/locations \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/locations', 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"
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,
"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"
}
],
"limit": 123,
"offset": 123,
"has_more": true
}{
"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
List housing units
One page of your housing units, by name. Without parent_id this is every unit at every level, foster homes and virtual placements included; with it, only the units directly inside that one. Needs read on Animals.
GET
/
api
/
animals
/
locations
List housing units
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/locations \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/locations', 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"
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,
"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"
}
],
"limit": 123,
"offset": 123,
"has_more": true
}{
"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. 50 unless you say, 200 at most.
Required range:
1 <= x <= 200How many to skip, for the next page.
Required range:
x >= 0Only the units directly inside this one.
Only units of this type.
Available options:
campus, building, room, cage, foster_home, virtual