List documents

get/v1/document/list

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.

Code snippet

curl -X 'GET' \ 'https://api.boldsign.com/v1/document/list?PageSize=10&Page=1&SentBy=string' \
     -H 'accept: application/json' \
     -H 'X-API-KEY: {your-api-key}'

var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}");
var documentClient = new DocumentClient(apiClient);
var documents = documentClient.ListDocuments(1, 10);

import boldsign

configuration = boldsign.Configuration(
    api_key = "YOUR_API_KEY"
)

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)

    list_documents_response = document_api.list_documents(page_size=10, page=1)

const axios = require('axios');
const response = await axios.get('https://api.boldsign.com/v1/document/list', {
    params: {
        'PageSize': '10',
        'Page': '1'
    },
    headers: {
        'accept': 'application/json',
        'X-API-KEY': '{your API key}'
    }
});

Query parameters

PageSizeinteger	The maximum number of team documents to be listed on a page. Defaults to `10.`
PageintegerRequired	The page number that you would like to view. Defaults to `1.`
SentByarray	Mail ID of the sender. One or more ID's can be specified.
Recipientsarray	Mail ID of the signer. One or more ID's can be specified.
StartDatestring	Start transmit date range of the document. The string should be in date-time format.
Statusarray	Current status of the document. You can set `None` if you don't want to filter based on the document status. Other values are `WaitingForMe,` `WaitingForOthers,` `NeedAttention,` `Completed,` `Declined,` `Revoked,` `Expired,` and `Draft.`
EndDatestring	End transmit date range of the document. The string should be in date-time format.
SearchKeystring	Query based on the details of the documents like document title, document ID, sender or recipient(s) name, etc.
Labelsarray	Labels (tags) specified in the document.
TransmitTypestring	Type of transmission such as `Sent,` `Received,` and `Both.`
NextCursorint	To facilitate pagination and fetch the next set of documents beyond 10,000 records, it is necessary to set the `nextCursor` value. This should be the `cursor` value of the last document retrieved. e.g:nextCursor: 1689815402493
BrandIdsarray	Filters documents based on their associated brand IDs.

Example response

200 Success

{
  "pageDetails": {
    "pageSize": 10,
    "page": 1,
    "totalRecordsCount": 28,
    "totalPages": 3,
    "sortedColumn": "activityDate",
    "sortDirection": "DESC"
  },
  "result": [
    {
      "documentId": "755195d8-xxxx-xxxx-xxxx-88ff77d35419",
      "senderDetail": {
        "name": "Richard",
        "privateMessage": null,
        "emailAddress": "richard@cubeflakes.com",
        "isViewed": false
      },
      "ccDetails": [
        {
          "emailAddress": "alexgayle@cubeflakes.com",
          "isViewed": false
        }
      ],
      "createdDate": 1664961706,
      "activityDate": 1665989290,
      "activityBy": "alexgayle@cubeflakes.com",
      "messageTitle": "565",
      "status": "InProgress",
      "signerDetails": [
        {
          "signerName": "Richard",
          "signerRole": "",
          "signerEmail": "",
          "status": "NotCompleted",
          "enableAccessCode": false,
          "isAuthenticationFailed": null,
          "enableEmailOTP": false,
          "authenticationType": "None",
          "isDeliveryFailed": false,
          "isViewed": false,
          "order": 1,
          "signerType": "Signer",
          "hostEmail": "",
          "hostName": "",
          "isReassigned": true,
          "privateMessage": "",
          "formFields": [],
          "language": 0
        }
      ],
      "expiryDate": 1670178599,
      "enableSigningOrder": false,
      "isDeleted": false,
      "labels": [],
      "nextCursor": 1665989290
    },
    {
      "documentId": "655195d8-xxxx-xxxx-xxxx-88ff77d35531",
      "senderDetail": {
        "name": "Alex Gayle",
        "privateMessage": null,
        "emailAddress": "alexgayle@cubeflakes.com",
        "isViewed": false
      },
      "ccDetails": [
        {
          "emailAddress": "richard@cubeflakes.com",
          "isViewed": false
        }
      ],
      "createdDate": 1665988967,
      "activityDate": 1665988967,
      "activityBy": "alexgayle@cubeflakes.com",
      "messageTitle": "Agreement",
      "status": "InProgress",
      "signerDetails": [
        {
          "signerName": "Richard",
          "signerRole": "",
          "signerEmail": "richard@cubeflakes.com",
          "status": "NotCompleted",
          "enableAccessCode": false,
          "isAuthenticationFailed": null,
          "enableEmailOTP": false,
          "authenticationType": "None",
          "isDeliveryFailed": false,
          "isViewed": false,
          "order": 1,
          "signerType": "Signer",
          "hostEmail": "",
          "hostName": "",
          "isReassigned": false,
          "privateMessage": "",
          "formFields": [],
          "language": 0
        },
        {
          "signerName": "Alex Gayle",
          "signerRole": "",
          "signerEmail": "alexgayle@cubeflakes.com",
          "status": "NotCompleted",
          "enableAccessCode": false,
          "isAuthenticationFailed": null,
          "enableEmailOTP": false,
          "authenticationType": "IdVerification",
          "isDeliveryFailed": false,
          "isViewed": false,
          "order": 2,
          "signerType": "Signer",
          "hostEmail": "",
          "hostName": "",
          "isReassigned": false,
          "privateMessage": "",
          "formFields": [],
          "language": 0,
          "idVerification": {
            "type": "EveryAccess",
            "maximumRetryCount": 3,
            "status": "Completed",
            "nameMatcher": "Strict",
            "requireLiveCapture": true,
            "requireMatchingSelfie": true,
            "holdForPrefill": false,
            "prefillCompleted": false
          }
        }
      ],
      "expiryDate": 1671820199,
      "enableSigningOrder": false,
      "isDeleted": false,
      "labels": [
        "Agreement"
      ],
      "nextCursor": 1689815402493
    }
  ]
}