Sparky Sign API
Documents sent for signature and where each signer is. Sending, signing and voiding stay in the app.
- Address
- https://sign.sparkyli.com/api/v1
- Plan
- Plus and Max, with API access switched on for the organization
- Specification
- https://sign.sparkyli.com/api/v1/openapi.yaml
Endpoints
GET /documents
Documents, newest first.
Your own, unless your role manages all documents.
Inputs
| Name | Type | What it is |
|---|---|---|
| status | draft, sent, viewed, signed, completed, declined or expired | Only documents in this state. |
| limit, offset | whole numbers | Paging: limit 1 to 100 (default 50); offset from next_offset. |
Answer: documents (a list) and next_offset
| Name | Type | What it is |
|---|---|---|
| id, title | text | |
| status | draft, sent, viewed, signed, completed, declined or expired | Where the document is. |
| approval_status | not_required, pending, approved or rejected | Whether a team approval was needed before sending. |
| tag | text or null | A free-text label. |
| created_at, sent_at, completed_at, expires_at | text or null | UTC time. |
| closed_reason | text or null | Why it can no longer be signed: voided or expired. |
GET /documents/{id}
One document with its signers and each signer's progress. Never the signing links, signatures or devices.
Inputs
| Name | Type | What it is |
|---|---|---|
| id* | text | The document's id. |
Answer: document
| Name | Type | What it is |
|---|---|---|
| (all the list fields, and these) | ||
| closed_note | text or null | A note left when the document was closed. |
| signers | list | In signing order: name, email, order_index (from 0), status (pending, viewed, signed or declined), viewed_at, signed_at and decline_reason. |
Errors (besides the common ones)
- 404 not_found: No such document, or it is not yours to see.
Example
curl -s -H "authorization: Bearer $TOKEN" "https://sign.sparkyli.com/api/v1/documents?status=sent"New here? Start with the three things first, then sign in. Errors are explained under errors and limits.