List All Contracts

get

https://example.com/v1/admin/contracts

List all contracts, 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 contract ID must contain, matched case-insensitively, matching every contract when
omitted. A term of one or two characters must equal the whole ID instead.

contract_type

array of objects

length between 1 and 200

Contract types to return, matching any one of them, returning every type when omitted.

contract_type

status

array of objects

length between 1 and 200

Statuses to return contracts in, matching any one of them, returning every status when
omitted.

status

Allowed:

digital_twin_only

boolean

Whether to return only contracts that involve only digital twins (transfers, issues and
redeems) or only those that do not, returning both when omitted. Only true or false is
accepted, so a blank value is a 400 rather than no filter.

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

Possible reasons:

failed to convert type
failed to get contracts from database

Language

Credentials

Loading…

Response

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

application/json

200OK