Skip to main content
GET
Get a household

Authorizations

Authorization
string
header
required

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

Path Parameters

personId
string
required

The person's ID.

Response

The household.

person
object
required
pets
object[]
required

Every pet, gone ones included.

current
object
required

The pets they have today.

visits
object[]
required

The 50 most recent.

household
object

Their proof of need.

this_month
object

This calendar month so far.

allowance
number | null

Pounds a month for the pets they have today, or null when you set no allowance.

warnings
string[]

Where they stand against your rules now, in words.