Skip to main content
GET
List all QC requests

Authorizations

Authorization
string
header
required

Owner-scoped bearer token. The owner a request is scoped to is derived from the token; list endpoints also take an explicit owner query parameter your token must be authorized to read.

Query Parameters

fields
string[]

Field mask restricting the response to the listed QC request fields. Comma-separated. id, createdOn, document, status and (for a single QC request) checklistItems are always included. When omitted, every field is returned except the reviewer and reviewee names and emails, which require looking up users and firms and so are only returned when requested: reviewedByName, reviewedByEmail, revieweeName, revieweeEmail, revieweeFirmName. Supported values: id, createdOn, document, status, checklistItems (single QC request only), actors, checklistName, checklistVersion, fileUrl, notes, processName, review, reviewStartedOn, reviewCompletedOn, reviewedBy, reviewedByName, reviewedByEmail, reviewee, revieweeName, revieweeEmail, revieweeFirm, revieweeFirmName. The special value * returns every field.

limit
integer
default:100

The number of items to return per page (default 10).

Required range: x >= 1
cursor
string

The cursor for fetching the next page of results.

owner
string
required

Owner to filter the results to.

orderDirection
enum<string>
default:asc

The direction to order the results by

Available options:
asc,
desc
orderBy
enum<string>
default:id

The column to order the results by, defaults to id

Available options:
id,
createdOn,
reviewCompletedOn,
document.matterReference,
document.preparedBy,
document.preparedOn,
document.firmId,
document.signedOn
filter
object

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

notaryRequired
boolean

Whether to filter requests to those requiring a notary (true) or just a signature (false). If empty, both types are returned.

wetInk
boolean

Whether to filter requests to wet ink documents (true) or exclude them (false). If empty, both are returned. Combines with notaryRequired. Wet-ink documents only reach QC in workflows where QC comes after signing.

Response

A paginated list of QC requests

qcRequests
object[]
pagination
object