Search check templates

get

https://{tenant}.onechurchsoftware.com/api/checks/templates

Retrieve the check print templates matching the given filters, ordered by name.

Required permission: Full Read Accounting

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return templates whose name contains the given text.

description

string

Return templates whose description contains the given text.

active

boolean

If true, returns only active templates; if false, only deactivated templates.

font

string

Comma-delimited list of font names (e.g. times_new_roman, courier_new); underscores match spaces.

style

string

Comma-delimited list of check stock styles: 1 = Default, 2 = Voucher.

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