Get document by ID

GET 
/document/:document_id

Get a document

Request

Path Parameters

document_id stringrequired

objectId of contact

Header Parameters

x-api-token stringrequired
Example: opensign.xxxx

Responses

200

successful operation

application/json

Schema

Schema

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

Signers

object[]

Array [

Name string

]

createdAt date
updatedAt date

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"
    }
  ],
  "createdAt": "2023-10-07T16:49:56.000Z",
  "updatedAt": "2023-10-07T16:49:56.000Z"
}

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...