Get Document list from status

GET 
/documentlist/:doctype

Document Types:

Retrieve a list of documents based on type

1. Draft Documents:

   • Documents that are currently in draft status.

2. In-Progress Documents:

   • Documents that are currently in progress.

3. Completed Documents:

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

4. Expired Documents:

   • Documents that have expired and are no longer accessible.

5. Declined Documents:

   • Documents that have been declined by the user.

Request

Path Parameters

doctype stringrequired

Possible values: [draft, inprogress, completed, expired, declined]

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

file string

title string

note string

folder

object

objectId string

name string

owner string

signers

object[]

Array [

role string

name string

email string

phone string

widgets

object[]

Array [

type string

Allowed values - signature, stamp.

x number

y number

w number

h number

page number

]

]

sendInOrder boolean

createdAt date

updatedAt date

]

Example (from schema)

{
  "result": [
    {
      "objectId": "FGik23bhUJ",
      "file": "https://exampleurl.com",
      "title": "sample doc",
      "note": "please sign document",
      "folder": {
        "objectId": "FGik23bhUJ",
        "name": "folder name"
      },
      "owner": "joe bee",
      "signers": [
        {
          "role": "ceo",
          "name": "joe bee",
          "email": "joebee@example.com",
          "phone": "456213871",
          "widgets": [
            {
              "type": "signature",
              "x": 244,
              "y": 71,
              "w": 38,
              "h": 46,
              "page": 1
            }
          ]
        }
      ],
      "sendInOrder": false,
      "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...