Skip to main content
GET
Get the housing board

Authorizations

Authorization
string
header
required

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

Query Parameters

root
string

One unit and everything inside it, at any depth, instead of everything.

include_retired
boolean
default:false

true to include retired units.

Response

The board.

results
object[]
required
truncated
boolean
required

Whether there were more than 2,000 units.

unplaced
object[]
required

Up to 200 animals in care that are in no place, or in a retired one. Always empty when you give root.