Skip to main content
GET
List requests

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Query Parameters

owner
string

Tenant owner for machine-to-machine requests

limit
integer
default:100

Number of items per page

Required range: x >= 1
cursor
string

Cursor for pagination

orderDirection
enum<string>
default:asc
Available options:
asc,
desc
status
enum<string>
Available options:
pending,
completed,
rejected
workflowStatus
enum<string>

Filter to requests at this point in the document workflow. Applied independently of status: a request can be completed and still be mid-workflow.

Where the document has reached across the whole workflow, which carries on after the request's own status is completed. A document is done once it has been both signed and reviewed, and workflows run those two steps in either order, so this is derived from those two facts rather than from a position in a sequence.

Available options:
draft,
prepared,
awaiting_signature,
wet_ink_pending,
awaiting_qc,
qc_rejected,
signature_rejected,
completed,
rejected
orderBy
enum<string>
default:id

The column to order the results by, defaults to id

Available options:
id,
crid,
createdOn,
matterId,
priority
filter
object

One or more columns and their values on which to filter results

Response

Paginated list of requests

pagination
object
fileRequests
object[]