Get Report Templates

get

https://example.com/v1/settlement

Get a list of report templates, narrowed by the supplied filters and search term.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

length ≥ 1

\S

Text the template name must contain, matched case-insensitively, matching every template
when omitted. A term of one or two characters must equal the whole name instead.

root_participant

array of uuids

length between 1 and 200

Root participants to return templates for, matching any one of them, returning every
template when omitted.

root_participant

array of uuids

length between 1 and 200

Templates to return, matching any one of them, returning every template when omitted.

sort_by

string

enum

Allowed:

sort_dir

string

enum

Direction to order the results in, descending when omitted.

Allowed:

page

integer

0 to 4294967295

Page number for paginated results.

page_size

integer

0 to 4294967295

Page size for paginated results.

Responses

400

search term must not be blank

The query string is missing a required parameter, or a parameter could not be parsed into its expected type.

401

Not authenticated

500

failed to get report templates

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK