Skip to main content
GET
List adoptions

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer
default:50

How many to read. 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
status
enum<string>

One status.

Available options:
active,
finalized,
reversed
adopter_person_id
string

One adopter's adoptions.

animal_id
string

One animal's adoptions.

application_id
string

The adoptions recorded from one application.

outstanding
enum<string>

true for only the adoptions whose balance is more than zero.

Available options:
true

Response

One page of adoptions.

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 adoptions match in all, or with outstanding=true, how many are on this page.

total_is_page_only
boolean
required

true when total counts only this page.