document
Get signing documents
List (unarchived) signing documents. Use /status/ if you need high-level information.
get/document/
Query parameters
groupstring required
Filter by a specific group, required.
archivedstring
Filter on archived status, default is false
emailstring
Filter by signer email
limitinteger
Length of dataset to return. Use with offset query to iterate through results.
offsetinteger
Offset from start of dataset. Use with the limit query to iterate through dataset.
statusinteger
Filter on document status
nosignersstring
Add value '1' to remove signers information for a faster query
created_gtstring date-time
Filter for those documents created after a certain time
modified_gtstring date-time
Filter for those documents modified after a certain time
Response
successful operation, list of document objects
Example response
{
"objects": [
{
"archived": false,
"auto_archive": true,
"cc_emails": "None",
"created": "2020-05-20T:15:10",
"do_email": false,
"download_final": false,
"group": "/api/v1/group/my-group/",
"modified": "2020-05-20T:15:10",
"name": "test cs_agreement",
"pdftext": "None",
"redirect": "https://example.com/redirect-receive/",
"resource_uri": "/api/v1/document/d0d0d0d0-d0fd0-d0d0-d0d0-d0d0d0d0d0d0/",
"signers": [
"/api/v1/signers/s0s0s0s0-s0s0-s0s0-s0s0-s0s0s0s0s0s0/, Joe, Biggins, joe.biggins@widgets.com, '', true, 20, 0",
"/api/v1/signers/s1s1s1s1-s1s1-s1s1-s1s1-s1s1s1s1s1s1/, Betty, MacLean, betty.maclean@widgets.comma, '', true, 10, 1"
],
"signer_in_order": true,
"status": 10,
"tag": "contract2020myref",
"tag1": "my_other_ref",
"tag2": "andFinalRef",
"template": "None",
"templatepdf": "/api/v1/templatepdf/p0p0p0p0-p0p0-p0p0-p0p0-p0p0p0p0p0p0/",
"text": "",
"user": "/api/v1/user/u0u0u0u0-u0u0-u0u0-u0u0-u0u0u0u0u0u0/",
"uuid": "d0d0d0d0-d0fd0-d0d0-d0d0-d0d0d0d0d0d0"
}
]
}