/api/v3/documents/search

Review all documents

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Context to retrieve documents for; e.g. t682

boolean

If true, groups documents by transaction; default is true

string

Filter to specific approval status; "A" = approved, "R" = rejected, "U" = not yet approved; can take multiple values

string

Filter to documents with a specific status

string

Filter to documents on transactions with a specific status; use filter property of response from /transactions/statuses; can take multiple values

string

Filter to active ('N') or lost ('D') transactions, or both; default is active transactions only; can take multiple values

string

Filter to buyers or sellers only; values are 'b' or 's'

string

Search on transaction ID or transaction name

integer

ID of the document type to filter on; can take multiple values

integer

ID of the document category to filter on; can take multiple values

integer

ID of the folder to filter on; can take multiple values

string

Field to order by; options are 'modified_ts' (default), 'filename', 'transaction_id', 'transaction_name', 'transaction_agent', 'transaction_address', 'transaction_status'

string

Sort direction; 'asc' or 'desc'; default is 'desc'

integer

Number of documents to return per page; default is 100

integer

Page to return; default is 1

Response

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json