Skip to main content
GET
List wish list items

Authorizations

Authorization
string
header
required

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

Query Parameters

status
enum<string>

open for items you are still asking for, closed for those you have stopped asking for. closed means you have stopped asking, which is not the same as enough having arrived: see is_fulfilled.

Available options:
open,
closed
category
enum<string>
Available options:
food,
medical,
supplies,
equipment,
enrichment,
other
priority
enum<string>
Available options:
low,
normal,
urgent
animal_id
string

Only items asked for on behalf of this animal.

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

results
object[]
required
total
integer
required

How many items match in all.

limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.

still_needed
object
required

Over every matching item, not only this page.