Skip to main content
GET
List housing units

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 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
parent_id
string

Only the units directly inside this one.

unit_type
enum<string>

Only units of this type.

Available options:
campus,
building,
room,
cage,
foster_home,
virtual

Response

One page of units.

results
object[]
required
limit
integer
required
offset
integer
required
has_more
boolean
required

Whether there is another page after this one.