signatures.list
Signature requests for a job, a customer or a whole shop, newest first, with status and who signed. Filter by kind, status or subject_id.
When to use it
Ask a customer, or someone in the shop, to sign a document: contract text you supply (for example a service agreement) or a PDF already stored on the job. signatures.request returns a sign_url on the hosted pages; send it to the signer yourself.
What to tell the owner
Tell them what you found in plain words. Don't read back raw fields.
| Field | Type | Required |
|---|
shop_id | string (uuid) | no |
job_id | string (uuid) | no |
customer_id | string (uuid) | no |
kind | string | no |
subject_id | string (uuid) | no |
status | string (one of open, signed, cancelled) | no |
limit | integer | no |
Example
GET https://doingwork.work/v1/signatures?shop_id=00000000-0000-4000-8000-000000000000&job_id=00000000-0000-4000-8000-000000000000&customer_id=00000000-0000-4000-8000-000000000000&kind=...&subject_id=00000000-0000-4000-8000-000000000000&status=open&limit=1
Output
| Field | Type | Always there |
|---|
items | array | yes |
items[].signature_request_id | string (uuid) | yes |
items[].shop_id | string (uuid) | yes |
items[].job_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].customer_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].kind | string | yes |
items[].subject_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].title | string | yes |
items[].job_document_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].document_sha256 | string | yes |
items[].signer_role | string | yes |
items[].signer_email | ['string', 'null'] | yes |
items[].status | string | yes |
items[].created_by | string (uuid) | yes |
items[].created_at | string (date-time) | yes |
items[].cancelled_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
items[].signature_id | ['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')'] | yes |
items[].signer_name | ['string', 'null'] | yes |
items[].signed_at | ['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')'] | yes |
{
"items": [
{
"signature_request_id": "00000000-0000-4000-8000-000000000000",
"shop_id": "00000000-0000-4000-8000-000000000000",
"job_id": "00000000-0000-4000-8000-000000000000",
"customer_id": "00000000-0000-4000-8000-000000000000",
"kind": "...",
"subject_id": "00000000-0000-4000-8000-000000000000",
"title": "...",
"job_document_id": "00000000-0000-4000-8000-000000000000",
"document_sha256": "...",
"signer_role": "...",
"signer_email": "...",
"status": "...",
"created_by": "00000000-0000-4000-8000-000000000000",
"created_at": "...",
"cancelled_at": "...",
"signature_id": "00000000-0000-4000-8000-000000000000",
"signer_name": "...",
"signed_at": "..."
}
]
}
Errors
| Code | Status | What to do |
|---|
invalid_input, invalid_token, rate_limited | | Can happen on any call. See errors. |