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
Get List of Files
GET: /v1/documents/{docID}/files/
Description
Retrieve a list of all of the files on a certain document given the document ID
Format
JSON <multipart/related>
URL Parameters
None (Replace docID with the document ID)
Data Parameters
None
Response
Response returns a response containing the list of files on the document or an error response
Response Parameters
| Field | Mandatory | Type | Description |
|---|---|---|---|
| success | Yes | Boolean | True if the request was successful, False otherwise |
| id | Yes | Integer | ID for the individual files |
| name | Yes | String | The name of the file |
| size | Yes | String | The size of the individual files |
EXAMPLE REQUEST / RESPONSE (Python)
Request:
requests.get('https://siogn.signority.com/api/v1/documents/{doc_id}/files/', auth=(apiKey, ''))
Response:
{
'files': [
{
'id': 28721,
'name': 'blank',
'sequence': 1,
'type': 151
},
{
'id': 28722,
'name': 'blank',
'sequence': 1,
'type': 151
}
],
'success': True
}