Documents
Document List
Returns a paginated, optionally filtered and sorted list of documents.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Query Parameters
top?integer
Maximum number of records to return (page size).
skip?integer
Number of records to skip (page offset).
orderby?string
Sort clause in the form Column|DIRECTION, e.g. Name|DESC. The column and direction are separated by a pipe (|).
filter?string
URL-encoded JSON array of filter clauses (see FilterDTO). Example (decoded): [{"key":"Filter1","column":"Name","type":"string","condition":"CONTAINS","value":"Invoice"}].
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/documents/document/list"{ "result": { "data": { "documents": [ { "documentGuid": "16fd2706-8baf-433b-82eb-8c7fada847da", "subscriptionGuid": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "ownerGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "lastModifiedUserGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "title": "Invoice INV-2026-000123", "urn": "e3b0c442-98fc-4e1a-8a3d-2c1b5f6e9a70", "url": "https://storage.example.com/documents/inv-2026-000123.pdf", "path": "documents/inv-2026-000123.pdf", "fileFormat": "pdf", "deliveryMethod": "Email", "viewAnonymousLink": "", "editAnonymousLink": "", "viewUserLink": "", "editUserLink": "", "viewOrganizationLink": "", "editOrganizationLink": "", "succeededViewUserEmailList": "alice@example.com", "succeededEditUserEmailList": "bob@example.com", "failedViewUserEmailList": "ops@example.com", "failedEditUserEmailList": "ops@example.com", "createdDate": "2026-07-14T09:30:00.000Z", "lastModifiedDate": "2026-07-14T09:30:00.000Z", "isDeleted": false } ], "rowCount": 1 }, "statusCode": 200, "message": "OK" }, "origin": "GET https://api.doctavian.com/v1/documents/document/list", "dateTime": "2026-07-14T09:30:00.000Z", "operationId": "6becadfeef339fb2600188ebb939edf4", "userId": "52784927-0506-4ae3-93ff-16b0cc6553f8"}{ "userId": "19c0f493-252d-41b2-a3aa-eff66888b03e", "error": { "statusCode": 400, "message": "Name is required.", "innerErrors": [ { "code": "DATA_NAME_REQUIRED", "message": "Name is required.", "userMessage": "Name is required." } ] }, "origin": "GET https://api.doctavian.com/v1/documents/document/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "04f5662fe70dd5f71e6c14c21383f8b8"}{ "error": { "statusCode": 401, "message": "The request could not be authenticated.", "innerErrors": [ { "code": "UNAUTHORIZED", "message": "The request could not be authenticated.", "userMessage": "Your session has expired or is invalid. Please sign in again." } ] }, "origin": "GET https://api.doctavian.com/v1/documents/document/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "f04bc50946b26f75a6b1002945ef48b2", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "error": { "statusCode": 404, "message": "The requested resource was not found.", "innerErrors": [ { "code": "NOT_FOUND_BY_ID", "message": "The requested resource was not found.", "userMessage": "We couldn't find that resource. Check the id and try again." } ] }, "origin": "GET https://api.doctavian.com/v1/documents/document/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "72cb083286c803d74b0409207ae35992", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "userId": "0358e43c-6a83-4d4a-a1e0-d0b070fad0a8", "error": { "statusCode": 500, "message": "An unexpected error occurred.", "innerErrors": [ { "code": "GET_DATA_SOURCE_ERROR", "message": "An unexpected error occurred.", "userMessage": "An unexpected error occurred." } ] }, "origin": "GET https://api.doctavian.com/v1/documents/document/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "8a891a0a86015c08c8d72a2aefd9802f"}