API Docs / Operations / Document Requests / List Document Requests

List Document Requests

GET /tenants/{tenant}/documentrequests

Returns a paged list of document requests across all clients.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

sortBy query enum

Field to sort by.

Title Status CreatedDate Deadline

Field to sort by.

Title Status CreatedDate Deadline

sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

status query string

Filter by request status (Draft, Open, Submitted, Accepted, Rejected, Cancelled)

Filter by request status (Draft, Open, Submitted, Accepted, Rejected, Cancelled)

clientCode query string

Filter by client code

Filter by client code

managerCode query string

Filter by client manager user code

Filter by client manager user code

partnerCode query string

Filter by client partner user code

Filter by client partner user code

taskCategoryCode query string

Filter by task category code

Filter by task category code

search query string

Search across request title and description (minimum 3 characters)

Search across request title and description (minimum 3 characters)

Responses

401 Unauthorized – Invalid or missing API key

Try it