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

code number

result

document

objectId string

Title string

Note string

Folder string

File string

Owner string

Signers

object[]

Array [

Name string

]

Example (from schema)

{
  "code": 200,
  "result": {
    "objectId": "FGik23bhUJ",
    "Title": "sample doc",
    "Note": "please sign document",
    "Folder": "OpenSign™ Drive",
    "File": "https://exampleurl.com",
    "Owner": "joe bee",
    "Signers": [
      {
        "Name": "joe"
      }
    ]
  }
}

404

Document not found!

application/json

Schema

Schema

code number
message string

Example (from schema)

{
  "code": 404,
  "message": "Document not found!"
}

405

Invalid API Token!

application/json

Schema

Schema

code number
message string

Example (from schema)

{
  "code": 405,
  "message": "Invalid API token!"
}

Loading...