Search files

get

https://{tenant}.onechurchsoftware.com/api/cms/documents/{type}

Retrieve a list of files attached to records of the given type. Supply attachedTo to return the files attached to a single record. The required permission depends on the file's link type: person files require Read Files; business files require Limited Read Contributions or Full Read Accounting; batch files require Limited Read Contributions; bank_reconciliation files require Full Read Accounting; and group files require being an administrator or member of the group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string

required

The type of record the files are attached to. One of person, group, business, sermon, bank_reconciliation or batch.

Query Params

name

string

Return files whose display name or original file name contains the given text. When multiple words are given, every word must match.

description

string

Return files whose description contains the given text.

created.start

date-time

Return files uploaded on or after this date.

created.end

date-time

Return files uploaded on or before this date.

size.start

double

Return files at least this large, in kilobytes.

size.end

double

Return files at most this large, in kilobytes.

string

Return files uploaded by the given user name.

attachedTo

int32

The id of the record the files are attached to.

secondary

int32

The id of a secondary linked record.

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