Skip to main content
POST
Record a visit

Authorizations

Authorization
string
header
required

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

Body

application/json
items
object[]
required
Required array length: 1 - 40 elements
person_id
string | null

A household (a person with the pantry_client role). Refused when your pantry keeps no names; required when it keeps every name. Required when it keeps every name, unless the visit is to a partner agency.

visited_on
string<date>

Today when left out. Not a day still to come.

site
string | null

One of your locations, by its ID in Settings.

dogs
integer

Left out, the household's own dogs on file on that day; 0 for a walk-up.

Required range: 0 <= x <= 500
cats
integer
Required range: 0 <= x <= 500
other_pets
integer
Required range: 0 <= x <= 500
notes
string | null
organization_id
string | null

One of your partner agencies, by its organization ID. Not with person_id. Allowed whatever your records setting is.

Response

The visit.

id
string
required
person_id
string | null
required

The household, or null for a walk-up.

visited_on
string<date>
required
dogs
integer
required
cats
integer
required
other_pets
integer
required
pounds
number
required

Every line's pounds, added up.

items
object[]
required
household_name
string | null
location_unit_id
string | null
site_name
string | null
org_location_id
string | null

The site, as one of your locations in Settings.

notes
string | null
recorded_by_person_id
string | null
created_at
string<date-time>
organization_id
string | null

A partner agency the food went to, instead of a household.

partner_name
string | null
warnings
string[]

On a visit just recorded: what it did against your rules, in words. Empty when it broke none.