Get document list by doctype

POST 
/documentlist/:doctype

Document Types:

Retrieve a list of documents based on type

1. Draft Documents:

   • Documents that are currently in draft status.

2. Signature Requests:

   • Documents that require the your signature.

3. In-Progress Documents:

   • Documents that are currently in progress.

4. Completed Documents:

   • Documents that have been successfully completed with all required signatures.

5. Expired Documents:

   • Documents that have expired and are no longer accessible.

6. Declined Documents:

   • Documents that have been declined by the user.

Request

Path Parameters

doctype stringrequired

Possible values: [draftdocuments, signaturerequest, inprogressdocuments, completedocuments, expiredocuments, declinedocuments]

The type of documents to retrieve

Header Parameters

x-api-token stringrequired
Example: opensign.xxxx

application/json

Body

limit number
skip number

Responses

200

successful operation

application/json

Schema

Schema

• Array [

objectId string
Title string
Note string
Folder string
File string
Owner string

Signers

object[]

Array [

Name string

]

• ]

Example (from schema)

[
  {
    "objectId": "FGik23bhUJ",
    "Title": "sample doc",
    "Note": "please sign document",
    "Folder": "OpenSign™ Drive",
    "File": "https://exampleurl.com",
    "Owner": "joe bee",
    "Signers": [
      {
        "Name": "joe"
      }
    ]
  }
]

404

Report not available!

application/json

Schema

Schema

code number
message string

Example (from schema)

{
  "code": 404,
  "message": "Report not available!"
}

405

Invalid API Token!

application/json

Schema

Schema

code number
message string

Example (from schema)

{
  "code": 405,
  "message": "Invalid API token!"
}

Loading...