List signing requests
Signing requests, newest first, by cursor. Requests for restricted or health documents aren't shown to API keys.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
agoo_ck_live_ | Check API key, live mode, for a Check API partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As above, answering only the published test values, never billed |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: signing:read
status?stringOnly these.
"checking""sent""sealing""completed""declined""voided""expired"person_id?string^person_[0-7][0-9a-hjkmnp-tv-z]{25}$after?stringThe cursor: next_cursor from the last page.
^sign_[0-7][0-9a-hjkmnp-tv-z]{25}$limit?integerint641 <= value <= 100OK
application/json- response
data*array<>|nullhas_more*booleannext_cursor*|Pass this as cursor to get the next page. null on the last page.
curl -X GET 'https://api.agoohq.com/v1/signing-requests'{ "data": [ { "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "declined_at": "2019-08-24T14:15:22Z", "documents": [ { "byte_size": 0, "hr_document_id": "string", "id": "string", "pages": 0, "position": 0, "sealed": true, "sealed_byte_size": 0, "sha256": "string", "status": "string", "title": "string", "verify": null } ], "events": [ { "property1": null, "property2": null } ], "expires_at": "2019-08-24T14:15:22Z", "id": "string", "message": "string", "order": "string", "person": "string", "person_id": "string", "sender": "string", "sent_at": "2019-08-24T14:15:22Z", "signers": [ { "asked_at": "2019-08-24T14:15:22Z", "by_link": true, "channels": [ "string" ], "contact": "string", "decline_reason": "string", "id": "string", "last_reminded_at": "2019-08-24T14:15:22Z", "method": "string", "name": "string", "person_id": "string", "placements": null, "position": 0, "role": "string", "signed_at": "2019-08-24T14:15:22Z", "status": "string", "viewed_at": "2019-08-24T14:15:22Z" } ], "source_kind": "string", "status": "checking", "title": "string", "type_id": "string", "version": 0, "visibility": "string", "void_reason": "string", "voided_at": "2019-08-24T14:15:22Z" } ], "has_more": true, "next_cursor": "string"}API reference
Every endpoint and webhook event of the Agoo REST API, generated from the OpenAPI 3.1 contract.
Send documents for signature POST
Sends up to ten PDFs to up to 25 signers, in order or together. Someone in your directory signs in Agoo; anyone else gets a one-time link by email, SMS or both, chosen for this message. New files are checked for viruses before anyone is asked. When everyone has signed, Agoo seals each PDF with a certificate page and a QR code, and fires signing.completed.