Get the envelope as seen by the authenticated signer
curl --request GET \
--url https://api.atlaswork.ai/api/signer/envelope \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atlaswork.ai/api/signer/envelope', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/signer/envelope"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"envelope": {
"id": "<string>",
"version": 123,
"legalFramework": "<string>",
"consumerDisclosure": true,
"originalFilename": "<string>",
"displayName": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
},
"me": {
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"orderIndex": 123,
"name": "<string>",
"email": "<string>",
"consentedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"lastViewedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 123
},
"participants": [
{
"orderIndex": 123
}
],
"fields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
],
"completedFields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
],
"isMyTurn": true,
"senderName": "<string>",
"senderEmail": "<string>",
"branding": {
"displayName": "<string>",
"logoUrl": "<string>",
"accentColor": "<string>",
"logoWidth": 1,
"logoHeight": 1
},
"documentUrl": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}signer
Get the envelope as seen by the authenticated signer
Party-scoped read: returns the envelope summary, the signer’s own participant record and fields, position/progress slots for every participant (no names or emails), and a short-lived documentUrl. For a participant whose turn has not arrived, fields is empty and documentUrl is null. Records a throttled participant.viewed event.
GET
/
api
/
signer
/
envelope
Get the envelope as seen by the authenticated signer
curl --request GET \
--url https://api.atlaswork.ai/api/signer/envelope \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atlaswork.ai/api/signer/envelope', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/signer/envelope"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"envelope": {
"id": "<string>",
"version": 123,
"legalFramework": "<string>",
"consumerDisclosure": true,
"originalFilename": "<string>",
"displayName": "<string>",
"expiresAt": "2023-11-07T05:31:56Z"
},
"me": {
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"orderIndex": 123,
"name": "<string>",
"email": "<string>",
"consentedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"lastViewedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 123
},
"participants": [
{
"orderIndex": 123
}
],
"fields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
],
"completedFields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
],
"isMyTurn": true,
"senderName": "<string>",
"senderEmail": "<string>",
"branding": {
"displayName": "<string>",
"logoUrl": "<string>",
"accentColor": "<string>",
"logoWidth": 1,
"logoHeight": 1
},
"documentUrl": "<string>"
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}Authorizations
HMAC-signed envelope token, as a bearer token or a token query param.
Response
The signer-scoped envelope view
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I