Document List
GET {{apiBaseUrl}}/v1/document/list?page=1&pagesize=5
The list of documents that are available in your My Documents section can be fetched. The documents can be fetched based on their status, sender, recipient, labels, document details, etc. You can also limit the maximum number of documents to be fetched and their position. After the successful get, the entire details of all the queried documents will be displayed.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | number | The page number that you would like to view. Defaults to 1. | |
pagesize | number | The maximum number of team documents to be listed on a page. Defaults to 10. |
RESPONSES
status: OK
{"pageDetails":{"pageSize":5,"page":1,"totalRecordsCount":90,"totalPages":18,"sortedColumn":"activityDate","sortDirection":"DESC"},"result":[{"documentId":"6a59df75-bf48-4526-87f8-59d40b16c7c0","senderDetail":{"name":"Cathy Sam","privateMessage":null,"emailAddress":"cathysam@cubeflakes.com","isViewed":false},"ccDetails":[{"emailAddress":"luthercooper@cubeflakes.com","isViewed":false}],"createdDate":1721376814,"activityDate":1721376879,"activityBy":"mathewwilson@cubeflakes.com","messageTitle":"Legal Agreement","status":"Completed","signerDetails":[{"signerName":"Mathew Wilson","signerRole":"","signerEmail":"mathewwilson@cubeflakes.com","status":"Completed","enableAccessCode":true,"isAuthenticationFailed":null,"enableEmailOTP":false,"authenticationType":"AccessCode","isDeliveryFailed":false,"isViewed":true,"order":1,"signerType":"Signer","hostEmail":"","hostName":"","isReassigned":false,"privateMessage":"","allowFieldConfiguration":false,"formFields":[],"language":0,"locale":"EN","phoneNumber":null,"idVerification":null,"recipientNotificationSettings":null}],"expiryDate":1726597799,"enableSigningOrder":true,"isDeleted":false,"labels":[],"cursor":1721376879000},{"documentId":"fd0838c6-84e7-485b-8a33-9febcea49473","senderDetail":{"name":"Cathy Sam","privateMessage":null,"emailAddress":"cathysam@cubeflakes.com","isViewed":false},"ccDetails":[{"emailAddress":"luthercooper@cubeflakes.com","isViewed":false}],"createdDate":1721376465,"activityDate":1721376465,"activityBy":"mathewwilson@cubeflakes.com","messageTitle":"Legal Agreement","status":"InProgress","signerDetails":[{"signerName":"Alex Gayle","signerRole":"","signerEmail":"mathewwilson@cubeflakes.com","status":"NotCompleted","enableAccessCode":true,"isAuthenticationFailed":null,"enableEmailOTP":false,"authenticationType":"AccessCode","isDeliveryFailed":false,"isViewed":true,"order":1,"signerType":"Signer","hostEmail":"","hostName":"","isReassigned":false,"privateMessage":"","allowFieldConfiguration":false,"formFields":[],"language":0,"locale":"EN","phoneNumber":null,"idVerification":null,"recipientNotificationSettings":null}],"expiryDate":1726597799,"enableSigningOrder":true,"isDeleted":false,"labels":[],"cursor":1721376465000},{"documentId":"c5a9df07-617b-4b4f-a2bc-a075947614b5","senderDetail":{"name":"Cathy Sam","privateMessage":null,"emailAddress":"cathysam@cubeflakes.com","isViewed":false},"ccDetails":[{"emailAddress":"luthercooper@cubeflakes.com","isViewed":false}],"createdDate":1721376311,"activityDate":1721376311,"activityBy":"mathewwilson@cubeflakes.com","messageTitle":"Legal Agreement","status":"InProgress","signerDetails":[{"signerName":"Mathew Wilson","signerRole":"","signerEmail":"mathewwilson@cubeflakes.com","status":"NotCompleted","enableAccessCode":true,"isAuthenticationFailed":null,"enableEmailOTP":false,"authenticationType":"AccessCode","isDeliveryFailed":false,"isViewed":true,"order":1,"signerType":"Signer","hostEmail":"","hostName":"","isReassigned":false,"privateMessage":"","allowFieldConfiguration":false,"formFields":[],"language":0,"locale":"EN","phoneNumber":null,"idVerification":null,"recipientNotificationSettings":null}],"expiryDate":1726597799,"enableSigningOrder":true,"isDeleted":false,"labels":[],"cursor":1721376311000},{"documentId":"80975d91-5f97-458c-bba6-29520e61ae36","senderDetail":{"name":"Cathy Sam","privateMessage":null,"emailAddress":"cathysam@cubeflakes.com","isViewed":false},"ccDetails":[],"createdDate":1721376120,"activityDate":1721376120,"activityBy":"mathewwilson@cubeflakes.com","messageTitle":"Digital Agent Agreement","status":"InProgress","signerDetails":[{"signerName":"Mathew Wilson","signerRole":"","signerEmail":"mathewwilson@cubeflakes.com","status":"NotCompleted","enableAccessCode":false,"isAuthenticationFailed":null,"enableEmailOTP":false,"authenticationType":"None","isDeliveryFailed":false,"isViewed":true,"order":1,"signerType":"Signer","hostEmail":"","hostName":"","isReassigned":false,"privateMessage":"","allowFieldConfiguration":false,"formFields":[],"language":0,"locale":"EN","phoneNumber":null,"idVerification":null,"recipientNotificationSettings":null}],"expiryDate":1726684199,"enableSigningOrder":false,"isDeleted":false,"labels":[],"cursor":1721376120000},{"documentId":"0ca0c07d-6900-4606-9055-1183dddb2b8f","senderDetail":{"name":"Cathy Sam","privateMessage":null,"emailAddress":"cathysam@cubeflakes.com","isViewed":false},"ccDetails":[{"emailAddress":"luthercooper@cubeflakes.com","isViewed":false}],"createdDate":1721376098,"activityDate":1721376098,"activityBy":"cathysam@cubeflakes.com","messageTitle":"Legal Agreement","status":"InProgress","signerDetails":[{"signerName":"Mathew Wilson","signerRole":"","signerEmail":"mathewwilson@cubeflakes.com","status":"NotCompleted","enableAccessCode":true,"isAuthenticationFailed":false,"enableEmailOTP":false,"authenticationType":"AccessCode","isDeliveryFailed":false,"isViewed":false,"order":1,"signerType":"Signer","hostEmail":"","hostName":"","isReassigned":false,"privateMessage":"","allowFieldConfiguration":false,"formFields":[],"language":0,"locale":"EN","phoneNumber":null,"idVerification":null,"recipientNotificationSettings":null}],"expiryDate":1726597799,"enableSigningOrder":true,"isDeleted":false,"labels":[],"cursor":1721376098000}]}