Skip to main content
GET
List submissions

Authorizations

Authorization
string
header
required

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

Query Parameters

form_id
string

Only the submissions to this form (its record ID).

form_kind
enum<string>

Only submissions to forms of this kind. A kind your key may not read answers 403. What a form is for, which decides the area its submissions belong to and so which keys may read them. adoption_application, foster_application and surrender (a surrender request) are Animals; volunteer (a volunteer sign-up) is Shifts; donor is Fundraising; contact and general are People.

Available options:
adoption_application,
foster_application,
volunteer,
donor,
surrender,
contact,
general
status
enum<string>

Only submissions in this status. Without it, everything but spam. new until somebody reviews it; reviewed; converted once somebody converts it (see Convert a submission); spam, which is kept but left out of the list unless you ask for it. A submission caught by the spam trap on your public form arrives as spam. A submission joined to a person by itself when it arrived stays new, because nobody has reviewed it yet.

Available options:
new,
reviewed,
converted,
spam
decision
enum<string>

Only the approved, the rejected, or the ones not decided yet.

Available options:
approved,
rejected,
undecided
assignee
enum<string>

me: assigned to the person who made your key. nobody: assigned to nobody yet.

Available options:
me,
nobody
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 submissions.

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

Whether there is another page after this one.

total
integer
required

How many submissions match in all, of the ones your key can see.