Recipient
List of recipients
API Documentation
Contract
PDF and Word
Placeholder
Template
Recipient
List of recipients
Get a list of all recipients created in a specific contract.
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list",
"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",
"recipientKey": "RECIPIENT_KEY",
}
],
"code": "200",
"message": "Recipients found"
}
Body parameters
Action type.
ID of the contract. Use this parameter if you need to retrieve a contract’s recipients.
Response
Array of recipients.
ID of the recipient.
Create time.
Change time.
Name of the recipient.
Email of the recipient.
Custom message of the recipient.
Position of the recipient.
Action of the recipient.
Key of the recipient.
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list",
"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",
"recipientKey": "RECIPIENT_KEY",
}
],
"code": "200",
"message": "Recipients found"
}
curl -X POST 'https://api.sendforsign.com/api/recipient' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list",
"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",
"recipientKey": "RECIPIENT_KEY",
}
],
"code": "200",
"message": "Recipients found"
}