Get person form entries

get

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

Retrieve the form submissions linked to the given person. Equivalent to searching form entries filtered to the person.

Required permission: Limited Read People

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the person.

Query Params

form

string

Comma-delimited list of form ids.

formName

string

Return entries whose form's name contains the given text.

submitted.start

date-time

Return entries submitted on or after this date.

submitted.end

date-time

Return entries submitted on or before this date.

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.

confirmation

string

Return entries whose payment confirmation number contains the given text.

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.

200OK