Get Document

GET 
/document/:document_id

The Get Document API enables you to retrieve details about a specific document.

Request

Path Parameters

document_id stringrequired

objectId of Document

Responses

200

successful operation

application/json

Schema

Schema

objectId string
file string
title string
note string

folder

object

objectId string

name string
owner string

signers

object[]

Array [

name string

email string

phone string

]

createdAt date
updatedAt date

Example (from schema)

{
  "objectId": "FGik23bhUJ",
  "file": "https://exampleurl.com",
  "title": "sample doc",
  "note": "please sign document",
  "folder": {
    "objectId": "FGik23bhUJ",
    "name": "folder name"
  },
  "owner": "joe bee",
  "signers": [
    {
      "name": "joe bee",
      "email": "joebee@example.com",
      "phone": "456213871"
    }
  ],
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}

400

Something went wrong, please try again later!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Something went wrong, please try again later!"
}

404

Document not found!

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Document not found!"
}

405

Invalid API Token!

application/json

Schema

Schema

error string

Example (from schema)

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

Loading...