Skip to main content
GET
Export the foster homes as a CSV

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.

tag
string

Only homes with this tag, in any case.

Response

The CSV.

The response is of type string.