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 Document Folders
GET: /v1/folders
Description
This API call returns a list of document folders in your Signority account.
Format
JSON
URL Parameters
None
Data Parameters
None
Response
Returns a list of document folders for the user as well as it’s information or an error response.
Example Success Response:
{ "success": true, "folders": [ { "id": 115681, "UserId": 21688, "FolderText": "teamadmin_tx_archive", "text": "teamadmin_tx_archive", "metaData": "", "FolderType": { "codeName": "yes", "displayName": "Yes", "groupName": "yes_no", "id": 1, "sequence": 1 } }, { "id": 115682, "UserId": 21688, "FolderText": "123__archive", "text": "123__archive", "metaData": "", "FolderType": { "codeName": "yes", "displayName": "Yes", "groupName": "yes_no", "id": 1, "sequence": 1 } }, { "id": 115698, "UserId": 21688, "FolderText": "doc_t_archive", "text": "doc_t_archive", "metaData": "", } ] }
Example Error Response:
Code: not 400
or
{ 'message': [detailed error message] 'success': False }