Search envelopes

get

https://{tenant}.onechurchsoftware.com/api/contributions/envelopes

Retrieve giving envelope assignments matching the given filters.

Required permission: Limited Read Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

number

int32

≥ 1

Return the assignments for the given envelope number.

name

string

Text matched against the assigned person's first, middle, last and former names plus aliases. When multiple words are given, every word must match.

string

Return envelopes whose assigned person's email address contains the given text.

phone

string

Return envelopes whose assigned person's phone number contains the given digits.

address.street

string

The street address.

address.city

string

The city.

address.state

string

The state or province.

address.postalCode

string

The postal code.

address.country

string

The country.

type

string

Comma-delimited list of record type ids. Values come from /api/property_values/person_record_type/values.

campus

string

Comma-delimited list of campus (location) ids the assigned person belongs to. Use -1 to include people with no campus.

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