Get form entries

get

https://{tenant}.onechurchsoftware.com/api/forms/{form}/entries

Retrieve the submissions for the given form. Each entry includes its field responses, and entries support filtering by custom fields.

Required permission: Full Read Forms

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

form

int32

required

≥ 1

The id of the form.

Query Params

submitted.start

date-time

Return entries submitted on or after this date.

submitted.end

date-time

Return entries submitted on or before this date.

first

string

Return entries whose submitted first name contains the given text.

last

string

Return entries whose submitted last name contains the given text.

name

string

Text matched against the submitted and linked profile names. When multiple words are given, every word must match.

string

Return entries whose submitted email address contains the given text.

phone

string

Return entries whose submitted phone number contains the given digits.

address.street

string

Return entries whose submitted street address contains the given text.

address.city

string

Return entries whose submitted city contains the given text.

address.state

string

Return entries whose submitted state contains the given text. Use the full state name; abbreviations will not match.

address.postalCode

string

Return entries whose submitted postal code contains the given text.

campus

string

Comma-delimited list of campus (location) ids. Use -1 to include entries with no campus. Values come from /api/locations.

gender

string

Comma-delimited list of gender ids matched against the submitted gender. Use -1 to include entries with no gender. Values come from /api/property_values/gender/values.

maritalStatus

string

Comma-delimited list of marital status ids matched against the submitted marital status. Use -1 to include entries with no marital status. Values come from /api/property_values/marital_status/values.

unmatched

boolean

Whether the entry is not matched to a profile (true) or is (false).

linkedTo

int32

≥ 1

The id of the person the entries are linked to.

linkedToName

string

Return entries whose linked event, group or position name contains the given text.

ipAddress

string

Return entries submitted from the given IP address.

paymentMethod

string

Comma-delimited list of payment method ids. Values come from /api/property_values/transaction_methods/values.

coupon

string

Return entries whose coupon code contains the given text.

paid.start

double

Return entries that paid at least this amount.

paid.end

double

Return entries that paid at most this amount.

discount.start

double

Return entries discounted by at least this amount.

discount.end

double

Return entries discounted by at most this amount.

fees.start

double

Return entries with fees of at least this amount.

fees.end

double

Return entries with fees of at most this amount.

deposit.start

double

Return entries with a net deposit of at least this amount.

deposit.end

double

Return entries with a net deposit of at most this amount.

confirmation

string

Return entries whose payment confirmation number contains the given text.

batch

string

Return entries whose payment batch name contains the given text.

ignoreLinked

boolean

Exclude entries linked to a group, position or event.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK