Documents
Document Solution Get
Retrieves a single document solution by id, returning the same payload documents-solution-create returns: the solution with its attached templates, data sources and configurations, plus the server-assigned owner, timestamps and usage figures.
generatedDocumentCount and lastRequests give a quick read on how the solution is being used without querying the document requests separately.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Path Parameters
documentSolutionId*string
Id of the document solution to retrieve, as returned by documents-solution-create in result.data.documentSolution.id.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/documents/solution/d290f1ee-6c54-4b01-90e6-d701748f0851/get"{ "result": { "statusCode": 200, "message": "OK", "data": { "documentSolution": { "id": "d290f1ee-6c54-4b01-90e6-d701748f0851", "subscriptionId": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", "ownerId": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "lastModifiedUserId": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "name": "Quarterly Invoicing", "description": "Invoice run for quarterly billing.", "templates": [ { "id": "2b7c9e14-5a63-4f08-9d21-7c4e0b8a3f52", "name": "Standard Invoice", "description": "Company standard invoice layout.", "fileFormat": "docx" } ], "dataSources": [ { "id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301", "name": "Q3 Sales Report Data", "description": "Account records used for quarterly reports." } ], "configurations": [ { "id": "7f1b2c3d-4e5f-4a6b-9c8d-0e1f2a3b4c5d", "name": "Invoice - PDF via Email" } ], "ownerName": "Jane Doe", "lastModifiedUserName": "Jane Doe", "generatedDocumentCount": 42, "lastRequests": [ { "id": "5c9a1e73-8b40-4d2f-91a6-3e7d05b8c214", "name": "Invoice run - Contoso July", "createdDate": "2026-09-17T09:14:22.000Z", "status": "Completed" } ], "createdDate": "2026-09-01T08:30:11.000Z", "lastModifiedDate": "2026-09-17T09:14:22.000Z", "lastRequestDate": "2026-09-17T09:14:22.000Z" } } }, "origin": "GET https://api.doctavian.com/v1/documents/solution/{documentSolutionId}/get", "dateTime": "2026-09-18T12:15:53.000Z", "userId": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "operationId": "b5e0c31a7d92483fa4c61e08d7b3f925"}{ "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/solution/{documentSolutionId}/get", "dateTime": "2026-09-18T12:15:53.000Z", "userId": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "operationId": "b5e0c31a7d92483fa4c61e08d7b3f925"}{ "error": { "statusCode": 403, "message": "The caller is not authorized to perform this operation.", "innerErrors": [ { "code": "AUTHORIZATION_ERROR", "message": "The caller is not authorized to perform this operation.", "userMessage": "You do not have permission to do this. Contact your administrator." } ] }, "origin": "GET https://api.doctavian.com/v1/documents/solution/{documentSolutionId}/get", "dateTime": "2026-09-18T12:15:53.000Z", "userId": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "operationId": "b5e0c31a7d92483fa4c61e08d7b3f925"}Empty
{ "error": { "statusCode": 500, "message": "The document solution could not be retrieved.", "innerErrors": [ { "code": "GET_DOCUMENT_SOLUTION_ERROR", "message": "The document solution could not be retrieved.", "userMessage": "Something went wrong. Please try again or contact support." } ] }, "origin": "GET https://api.doctavian.com/v1/documents/solution/{documentSolutionId}/get", "dateTime": "2026-09-18T12:15:53.000Z", "userId": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d", "operationId": "b5e0c31a7d92483fa4c61e08d7b3f925"}