Common
Get a dashboard or self-service summary
Returns one of two response shapes, selected by the required type query parameter: dashboard returns per-caller envelope/task counts; self-service returns subscription/user/limit-breach aggregates the caller can administer.
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
type*string
Matched case-insensitively against dashboard/self-service. A missing or unrecognized value returns INVALID_SUMMARY_TYPE (400).
Value in
- "dashboard"
- "self-service"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/common/summary?type=dashboard"{ "result": { "data": { "todo": 3, "pending": 1, "inbox": 5, "expiring": 0, "completed": 42, "recentEnvelopes": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "NDA - Acme Corp", "status": "Completed" } ], "oldestTodoEnvelopes": [ { "id": "5a2e7b10-8c3e-4a1a-9e3a-1f2b3c4d5e6f", "name": "Vendor Agreement", "sendDate": "2026-06-01T12:00:00.000Z", "userName": "Jane Submitter", "tid": "7c9e6679-7425-40de-944b-e07fc1f90ae7" } ], "latestPendingEnvelopes": [ { "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "Offer Letter", "action": "Viewed", "timestamp": "2026-07-01T12:00:00.000Z", "person": "John Signer" } ] }, "statusCode": 200, "message": "OK" }, "origin": "GET https://api.doctavian.com/v1/common/summary", "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "e18abb7bd4a6249ab650fac6839e6b17", "userId": "a16c7247-26f9-4a1e-9714-b9e715dd2cd9"}{ "error": { "innerErrors": [ { "code": "INVALID_SUMMARY_TYPE", "message": "The provided summary type is not recognized.", "userMessage": "Please provide a valid summary type." } ], "message": "The provided summary type is not recognized.", "statusCode": 400 }, "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "67a9b7dca6b37f89da9d4d8ecae156cf", "origin": "GET https://api.doctavian.com/v1/common/summary", "userId": "dcd8692d-3979-4956-ab54-efcaceeea3e8"}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 401 }, "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "aa85152b537dbe2faf75554fab61d2ac", "origin": "GET https://api.doctavian.com/v1/common/summary", "userId": "445d7741-3a92-4eae-a845-83771f7fbea7"}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 403 }, "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "aade5332fda03501c396409b6e1be091", "origin": "GET https://api.doctavian.com/v1/common/summary", "userId": "b9765b78-2651-46bc-bc57-6b1586f5768f"}{ "error": { "innerErrors": [ { "code": "FUNCTION_EXECUTION_ERROR", "message": "An unexpected error occurred while processing the request.", "userMessage": "Something went wrong. Please contact support." } ], "message": "An unexpected error occurred while processing the request.", "statusCode": 500 }, "dateTime": "2026-01-02T12:34:56.000Z", "operationId": "1f1b87bd8b29595c99a4202cb688d5ed", "origin": "GET https://api.doctavian.com/v1/common/summary", "userId": "106a0e1c-e7ef-4562-b032-cef894b37e47"}