Search forms

get

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

Retrieve a list of forms matching the given filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return forms whose name contains the given text.

description

string

Return forms whose description contains the given text.

active

boolean

Whether the form is currently active. A form is active when it has no expiration date or the date has not passed yet.

category

string

Comma-delimited list of category ids. Use -1 to include forms with no category. Values come from /api/property_values/form_categories/values.

linked

boolean

Whether the form serves as the sign-up form for a group, event, or position. Linked forms cannot be filled out directly.

featured

boolean

Whether the form is featured.

submissions.start

double

Return forms with at least this many submissions.

submissions.end

double

Return forms with at most this many submissions.

events.start

double

Return forms used by at least this many events.

events.end

double

Return forms used by at most this many events.

groups.start

double

Return forms used by at least this many groups.

groups.end

double

Return forms used by at most this many groups.

positions.start

double

Return forms used by at least this many positions.

positions.end

double

Return forms used by at most this many positions.

earliest.start

date-time

Return forms whose first submission was on or after this date.

earliest.end

date-time

Return forms whose first submission was on or before this date.

latest.start

date-time

Return forms whose latest submission was on or after this date.

latest.end

date-time

Return forms whose latest submission was on or before this date.

filter

string

Full-text search text. Matching forms are returned ranked by relevance.

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:

Response

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