Documents
Document Solution Configuration List
Returns a paginated, optionally filtered and sorted list of document solution configurations.
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/configuration/list"{ "result": { "data": { "documentSolutionConfigurations": [ { "documentSolutionConfigurationGuid": "a3bb189e-8bf9-3888-9912-ace4e6543002", "documentSolutionGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851", "subscriptionGuid": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "ownerGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "lastModifiedUserGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "name": "Invoice - PDF via Email", "description": "Renders invoices as PDF and e-mails them to the customer.", "title": "Invoice", "fileFormat": "pdf", "processingType": "STANDARD", "deliveryMethod": "Email", "path": "output/invoices/", "pdfConformanceLevel": "PdfA2B", "pdfVersion": "2026-01-07", "language": "en", "locale": "en-US", "timeZone": "America/New_York", "embeddedData": "{\"companyName\":\"Contoso Ltd\"}", "viewAnonymous": false, "editAnonymous": false, "viewOrganization": true, "editOrganization": false, "viewUser": true, "editUser": false, "viewUserEmailList": "alice@example.com,bob@example.com", "editUserEmailList": "carol@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/configuration/list", "dateTime": "2026-07-14T09:30:00.000Z", "operationId": "f77f1d48820eaeba143b4df93f2c6c2d", "userId": "a9f9ddaa-e8be-4390-9df0-de2451dc8fed"}{ "userId": "0538e623-738a-4c0f-bdb1-fc3ec0e7de9b", "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/configuration/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "85f26eef9d404653a50a7d1dfb77501c"}{ "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/configuration/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "e59c984e9f5ecbbd30ae2d2ac2bc05d9", "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/configuration/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "5d1c8cef53fa83fccd4b85619074972d", "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}{ "userId": "e5b37cd5-0c97-4a72-837d-1e523224c220", "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/configuration/list", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "4d2b68198d21c7ea5253db85d887c565"}