Overview

List possible recipients

Summary

This endpoint will return a list of possible recipients to send to DocuSign

Request Arguments

Name Type Description
module String Context module
id String Context record id
offset Integer List offset

Response Arguments

Name Type Description
recipients Array Recipients list
totalNumberOfRecipients Integer Total number of recipients
nextOffset Integer Next offset

Response

    {
        "recipients": [{
            "id": "ee4008f2-fb14-11ec-a64f-0242ac140007",
            "name": "Income Free Investing LP",
            "first_name": "",
            "last_name": "",
            "email": "info96@example.edu",
            "module": "Accounts",
            "_module": "Accounts"
        }, {
            "id": "efcb5672-fb14-11ec-afb7-0242ac140007",
            "name": "Rafael Stecklein",
            "email": "im.im.info@example.de",
            "module": "Contacts",
            "_module": "Contacts"
        }],
        "totalNumberOfRecipients": 8,
        "nextOffset": 2
    }

Change Log

Version Change
v11_18 Added /DocuSign/getListOfPossibleRecipients GET endpoint.