Skip to main content
GET
List foster assignments

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>

Only assignments in this status.

Available options:
pending,
active,
completed,
declined
foster_home_id
string

Only this home's.

animal_id
string

Only this animal's.

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 assignments.

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 match in all.