List team documents

get/v1/document/teamlist

The team admin can view all the documents that are sent and received by the team members. In contrast, the account admin can view all the documents that are sent and received by all the team members. These documents are available in the Team Documents section in the BoldSign application. Please refer to the Create team article to know more details.

The team documents can be fetched based on their status, user id, team id, document details, etc. You can also limit the number of documents to be fetched and their position. After the successful get, all the queried documents details will be returned. If the user is not an account admin or team admin, then the unauthorized response will be returned.

Code snippet

 curl -X 'GET' \ 'https://api.boldsign.com/v1/document/teamlist?Status=WaitingForOthers&UserId=&PageSize=10&Page=1&TransmitType=%20Both' \
  -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 teamDocuments = documentClient.ListTeamDocuments(1, 10);
import requests

url = "https://api.boldsign.com/v1/document/teamlist?PageSize=10&Page=1"

payload={}
headers = {
  'accept': 'application/json',
  'X-API-KEY': '{your API key}'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
const response = await axios.get('https://api.boldsign.com/v1/document/teamlist', {
    params: {
        'PageSize': '10',
        'Page': '1'
    },
    headers: {
        'accept': 'application/json',
        'X-API-KEY': '{your API key}'
    }
})

Query parameters

h1h2
StatusarrayCurrent status of the team 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.
UserIdarrayID of the user in the team. One or more user IDs can be specified.
TeamIdarrayID of the team. One or more team IDs can be specified.
SearchKeystringQuery based on the details of the documents like document title, document ID, sender or recipient(s) name, etc.
PageSizeintegerThe maximum number of team documents to be listed on a page. Defaults to 10.
PageintegerRequiredThe page number that you would like to view. Defaults to 1.
EndDatestringEnd transmit date range of the document. The string should be in date-time format.
StartDatestringStart transmit date range of the document. The string should be in date-time format.
LabelsarrayLabels (tags) specified in the document.
TransmitTypestringType of transmission such as Sent, Received, and Both.

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,
          "isDeliveryFailed": false,
          "isViewed": false,
          "order": 1,
          "signerType": "Signer",
          "hostEmail": "",
          "hostName": "",
          "isReassigned": true,
          "privateMessage": "",
          "formFields": [],
          "language": 0
        }
      ],
      "expiryDate": 1670178599,
      "enableSigningOrder": false,
      "isDeleted": false,
      "labels": []
    },
    {
      "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,
          "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,
          "isDeliveryFailed": false,
          "isViewed": false,
          "order": 2,
          "signerType": "Signer",
          "hostEmail": "",
          "hostName": "",
          "isReassigned": false,
          "privateMessage": "",
          "formFields": [],
          "language": 0
        }
      ],
      "expiryDate": 1671820199,
      "enableSigningOrder": false,
      "isDeleted": false,
      "labels": [
        "Agreement"
      ]
    }
  ]
}