Client
List of clients
API Documentation
Contract
PDF and Word
Placeholder
Template
Client
List of clients
Get a list of all clients created via a specific API Key.
curl -X POST 'https://api.sendforsign.com/api/client' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list"
}
}'
{
"clients": [{
"createTime": "2023-12-01 12:18:55",
"changeTime": "2023-12-01 12:18:55",
"clientKey": "CLIENT_KEY",
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"organization": "Company Inc.",
"customKey": "YOUR_COMBINATION",
"multiple": true
}],
"code": "200",
"message": "Clients found"
}
All API calls related to the
/api/client endpoint require a Platform Bearer Token in the request header.Body parameters
Action type.
Response
Array of clients.
Create time.
Change time.
ID of the client.
First and second names of the client.
Email of the client.
Organization name.
Client custom key, if you used it when creating the client.
This parameter indicates that this client has users.
The code of the answer.
The message of the answer.
curl -X POST 'https://api.sendforsign.com/api/client' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list"
}
}'
{
"clients": [{
"createTime": "2023-12-01 12:18:55",
"changeTime": "2023-12-01 12:18:55",
"clientKey": "CLIENT_KEY",
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"organization": "Company Inc.",
"customKey": "YOUR_COMBINATION",
"multiple": true
}],
"code": "200",
"message": "Clients found"
}
curl -X POST 'https://api.sendforsign.com/api/client' \
-H 'Authorization: Bearer 123456789' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"action": "list"
}
}'
{
"clients": [{
"createTime": "2023-12-01 12:18:55",
"changeTime": "2023-12-01 12:18:55",
"clientKey": "CLIENT_KEY",
"fullname": "John Johnson",
"email": "john_johnson@mail.com",
"organization": "Company Inc.",
"customKey": "YOUR_COMBINATION",
"multiple": true
}],
"code": "200",
"message": "Clients found"
}