Skip to main content
POST
/
api
/
recipient
curl -X POST 'https://api.sendforsign.com/api/recipient' \ 
     -H 'X-Sendforsign-Key: YOUR_API_KEY' \
     -H 'Content-Type: application/json' \
     -d '{ 
          "data": {
              "action": "list",
              "clientKey": "YOUR_CLIENT_KEY",
              "contractKey": "CONTRACT_KEY"				  }
     }'

{
    "recipients": [
        {
            "id": "1",
            "createTime": "2024-02-26T11:07:55.000Z",
            "changeTime": "2024-02-26T11:07:59.000Z",
            "name": "Recipient Name",
            "email": "Recipient Email",
            "customMessage": "Custom message text",
            "position": "1",
            "action": "view",
            "clientKey": "YOUR_CLIENT_KEY",
            "recipientKey": "RECIPIENT_KEY",
        }
    ],
    "code": "200",
    "message": "Recipients found"
}

​
Body parameters

​
data
object
required

​
Response

​
recipients
string
Array of recipients.
​
code
string
The code of the answer.
​
message
string
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/recipient' \ 
     -H 'X-Sendforsign-Key: YOUR_API_KEY' \
     -H 'Content-Type: application/json' \
     -d '{ 
          "data": {
              "action": "list",
              "clientKey": "YOUR_CLIENT_KEY",
              "contractKey": "CONTRACT_KEY"				  }
     }'

{
    "recipients": [
        {
            "id": "1",
            "createTime": "2024-02-26T11:07:55.000Z",
            "changeTime": "2024-02-26T11:07:59.000Z",
            "name": "Recipient Name",
            "email": "Recipient Email",
            "customMessage": "Custom message text",
            "position": "1",
            "action": "view",
            "clientKey": "YOUR_CLIENT_KEY",
            "recipientKey": "RECIPIENT_KEY",
        }
    ],
    "code": "200",
    "message": "Recipients found"
}