Get document list by doctype

GET 
/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

Query Parameters

limit number
Possible values: <= 500
Example: 10
skip number
Example: 0

Responses

200

successful operation

application/json

Schema

Schema

result

document[]

Array [

objectId string

Title string

Note string

Folder string

File string

Owner string

Signers

object[]

Array [

Name string

]

createdAt date

updatedAt date

]

Example (from schema)

{
  "result": [
    {
      "objectId": "FGik23bhUJ",
      "Title": "sample doc",
      "Note": "please sign document",
      "Folder": "OpenSign™ Drive",
      "File": "https://exampleurl.com",
      "Owner": "joe bee",
      "Signers": [
        {
          "Name": "joe"
        }
      ],
      "createdAt": "2023-10-07T16:49:56.000Z",
      "updatedAt": "2023-10-07T16:49:56.000Z"
    }
  ]
}

404

Report not available!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Report not available!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Invalid API token!"
}

Loading...