API Docs / Operations / Client Documents / List Client Documents

List Client Documents

GET /tenants/{tenant}/clientdocuments

Returns a paged list of client documents across all clients. Defaults to only showing documents sent for client approval (ClientApprovalStatus != None).

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 Date UpdatedDate

Field to sort by.

Title Date UpdatedDate
sortDesc query boolean

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

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

Filter by document category code

Filter by document category code
reviewStatus query string

Filter by review status (Approved, PendingReview, Rejected)

Filter by review status (Approved, PendingReview, Rejected)
clientApprovalStatus query string

Filter by client approval status (None, Pending, Approved, Rejected)

Filter by client approval status (None, Pending, Approved, Rejected)
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 document name and description (minimum 3 characters)

Search across document name and description (minimum 3 characters)

Responses

200 OK
401 Unauthorized – Invalid or missing API key

Try it

Related Schemas

ClientDocumentDtoPagedResult