Fair API Pricing
No Surprise Fees
Secure Your Document Distribution and Management with a Signority API Plan
Home
Getting Started
API Reference
Use Cases
Frequently Asked Questions
Retrieve Template Report
GET: /v1/documents/{docID}/childrentags
Description
Retrieve a report of all the documents sent via a Signority Template. Includes Regular Templates, Template Links, and Bulk Signs.
Format
JSON <multipart/related>
URL Parameters
None (Replace docID with the document’s ID)
Data Parameters
None
Response
Response returns a response containing a list of all the documents that were created through the Template and the information associated with each document.
EXAMPLE REQUEST / RESPONSE (Python)
Request:
requests.get('https://test.signority.com/api/v1/documents/{doc_id}/childrentags', auth=(apiKey, ''))
Response:
{
"documents": [
{
"GUID": "3dde0696-e53a-423f-bd0f-5b72a40dc209",
"title": "6-page Sample Document_Matt Signority",
"id": 1044097,
"createdTime": "2022-06-01 09:01:14.0",
"documentSentTime": "2022-06-01 09:01:14.0",
"userId": 18648,
"documentType": 5,
"signingStatus": 53,
"signingStatusDisplay": "Complete",
"isPublished": false,
"pkiEnabled": false,
"version": 5,
"isRetentionEnabled": false,
"RetentionStartTimestamp": 0,
"RetentionPeriodInDays": 0,
"RetentionType": 0,
"FileLockTimestamp": 1654088791000,
"recipientName": "Matt Signority",
"recipientEmail": "mattsignority@gmail.com",
"tags": [
{
"id": 39662650,
"pageId": 9016171,
"invitationId": 1584439,
"invitationGUID": "80ebf212-ec6e-4528-9a51-48b1cbefbb91",
"type": 250,
"isMandatory": true,
"textValue": "",
"imageDataValue": "",
"name": "Sign_0",
"top": 185,
"left": 83,
"width": 107,
"height": 33,
"groupName": "",
"style": {
"font-size": "12pt"
},
"condition": "",
"recipientCreated": false,
"valueSelected": false
},
{
"id": 39662651,
"pageId": 9016171,
"invitationId": 1584439,
"invitationGUID": "80ebf212-ec6e-4528-9a51-48b1cbefbb91",
"type": 252,
"isMandatory": true,
"textValue": "Matt Signority",
"imageDataValue": "",
"name": "Name",
"top": 191,
"left": 246,
"width": 133,
"height": 13,
"groupName": "",
"style": {
"font-size": "12pt"
},
"condition": "",
"recipientCreated": false,
"valueSelected": false
},
{
"id": 39662652,
"pageId": 9016171,
"invitationId": 1584439,
"invitationGUID": "80ebf212-ec6e-4528-9a51-48b1cbefbb91",
"type": 255,
"isMandatory": true,
"textValue": "01/06/2022",
"imageDataValue": "",
"name": "Date_0",
"top": 245,
"left": 252,
"width": 53,
"height": 13,
"groupName": "",
"style": {
"dateFormat": "DD/MM/YYYY",
"font-size": "12pt"
},
"condition": "",
"recipientCreated": false,
"dateTimeValue": 1654056000000,
"valueSelected": false
}
]
},
{
"GUID": "2f84b2d1-8af3-4fbf-85ee-f7b30f2ba82c",
"title": "6-page Sample Document_Daniel Cheung",
"id": 1044098,
"createdTime": "2022-06-01 09:01:19.0",
"documentSentTime": "2022-06-01 09:01:19.0",
"userId": 18648,
"documentType": 5,
"signingStatus": 53,
"signingStatusDisplay": "Complete",
"isPublished": false,
"pkiEnabled": false,
"version": 5,
"isRetentionEnabled": false,
"RetentionStartTimestamp": 0,
"RetentionPeriodInDays": 0,
"RetentionType": 0,
"FileLockTimestamp": 1654088611000,
"recipientName": "Daniel Cheung",
"recipientEmail": " user01@signority.com",
"tags": [
{
"id": 39662653,
"pageId": 9016177,
"invitationId": 1584440,
"invitationGUID": "57098b8b-9dec-4f72-92bc-dd85500ebecf",
"type": 250,
"isMandatory": true,
"textValue": "",
"imageDataValue": "",
"name": "Sign_0",
"top": 185,
"left": 83,
"width": 107,
"height": 33,
"groupName": "",
"style": {
"font-size": "12pt"
},
"condition": "",
"recipientCreated": false,
"valueSelected": false
},
{
"id": 39662654,
"pageId": 9016177,
"invitationId": 1584440,
"invitationGUID": "57098b8b-9dec-4f72-92bc-dd85500ebecf",
"type": 252,
"isMandatory": true,
"textValue": "Daniel Cheung",
"imageDataValue": "",
"name": "Name",
"top": 191,
"left": 246,
"width": 133,
"height": 13,
"groupName": "",
"style": {
"font-size": "12pt"
},
"condition": "",
"recipientCreated": false,
"valueSelected": false
},
{
"id": 39662655,
"pageId": 9016177,
"invitationId": 1584440,
"invitationGUID": "57098b8b-9dec-4f72-92bc-dd85500ebecf",
"type": 255,
"isMandatory": true,
"textValue": "01/06/2022",
"imageDataValue": "",
"name": "Date_0",
"top": 245,
"left": 252,
"width": 53,
"height": 13,
"groupName": "",
"style": {
"dateFormat": "DD/MM/YYYY",
"font-size": "12pt"
},
"condition": "",
"recipientCreated": false,
"dateTimeValue": 1654056000000,
"valueSelected": false
}
]
}
],
"success": true
}