curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/foster-homes \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/foster-homes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/foster-homes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"person_id": "<string>",
"status": "active",
"capacity": 123,
"spots_filled": 123,
"spots_available": 123,
"is_full": true,
"species_preferences": [
"<string>"
],
"accepts_medical": true,
"accepts_bottle_babies": true,
"accepts_behavioral": true,
"approved_on": "<string>",
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"person": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123,
"total_is_page_only": 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)"
}List foster homes
One page of your foster homes, active ones first, then by the foster’s last and first name. Each comes with how many spots are filled and free. Needs read on Animals.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/animals/foster-homes \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/animals/foster-homes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/foster-homes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"id": "<string>",
"person_id": "<string>",
"status": "active",
"capacity": 123,
"spots_filled": 123,
"spots_available": 123,
"is_full": true,
"species_preferences": [
"<string>"
],
"accepts_medical": true,
"accepts_bottle_babies": true,
"accepts_behavioral": true,
"approved_on": "<string>",
"notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"person": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"display_name": "<string>",
"email": "<string>",
"phone": "<string>"
}
}
],
"limit": 123,
"offset": 123,
"has_more": true,
"total": 123,
"total_is_page_only": 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
Only homes in this status.
active, paused, inactive The home of one person.
Only homes that take this species, which includes every home with no preference.
true for only homes with a free spot. This is applied to the page after it is read, so a page can come back shorter than limit, and total then counts this page only.
How many to return. 50 unless you say, 200 at most.
1 <= x <= 200How many to skip, for the next page.
x >= 0Response
One page of foster homes.
Show child attributes
Show child attributes
Whether there is another page after this one.
How many homes match in all, or on this page when total_is_page_only is true.
True when you asked for available homes only.