Get document
Retrieve all the details about a document and signing progress
- Overview
-
Get details about a single document
- See the current status of the document and signers
- When the signers completed the document
- Field input values
- End Point
- https://goodsign.io/api/document/:uuid
- Method
- GET
- Authentication
- Bearer your_api_token
- Response
-
{ "master_doc": { "name": "API Configuration.pdf", "signers": [ { "contact": { "name": "John Ballinger", "email": "au@goodsign.io" }, "complete": null, "reminderdays": 0, "emailopened": null, "completetime": null, "verifysmspass": null, "verifyid": null, "template_rolename": null, "key": null, "emailStatus": null } ], "fields": [ { "complete": null, "type": "sign", "value": null, "subtype": null, "valuetype": null, "apiref": "8ae8fc2d-e2f9-4a9f-828a-134c699debcc", "contact": "au@goodsign.io" } ], "completed_time": null, "status": "archived", "cc": "", "is_attachment": null, "istemplate": null, "webhook": null, "metadata": [], "note": "this is cool", "uuid": "4c54b60c-d010-438d-a505-04d123a6547f", "download_pdf": "https:\/\/goodsign.io\/api\/download\/4c54b60c-d010-438d-a505-04d123a6547f", "download_zip": "https:\/\/goodsign.io\/api\/downloadzip\/4c54b60c-d010-438d-a505-04d123a6547f" }, "attachments": [] }
-
Working Curl Request
Uses JSON and signers from above.
(excludes any fields & metadata) -
curl --request GET \ --url https://goodsign.io/api/document/4c54b60c-d010-438d-a505-04d123a6547f \ --header 'authorization: Bearer YOUR_API_TOKEN'