Skip to main content

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

Body

    limit number
    skip number

Responses​

successful operation

Schema

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

    Signers

    object[]

  • Array [

    • Name string

  • ]

Loading...