Skip to main content
GET
List foster homes

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

status
enum<string>

Only homes in this status.

Available options:
active,
paused,
inactive
person_id
string

The home of one person.

species
string

Only homes that take this species, which includes every home with no preference.

available
boolean
default:false

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.

limit
integer
default:50

How many to return. 50 unless you say, 200 at most.

Required range: 1 <= x <= 200
offset
integer
default:0

How many to skip, for the next page.

Required range: x >= 0

Response

One page of foster homes.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

total
integer
required

How many homes match in all, or on this page when total_is_page_only is true.

total_is_page_only
boolean
required

True when you asked for available homes only.