Docs
API referencePeople and H R

List signing requests

Preview· P9
GET
/signing-requests

Signing requests, newest first, by cursor. Requests for restricted or health documents aren't shown to API keys.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs 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 partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs 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

Query Parameters

status?string

Only these.

Value in"checking""sent""sealing""completed""declined""voided""expired"
person_id?string
Match^person_[0-7][0-9a-hjkmnp-tv-z]{25}$
after?string

The cursor: next_cursor from the last page.

Match^sign_[0-7][0-9a-hjkmnp-tv-z]{25}$
limit?integer
Formatint64
Range1 <= value <= 100

Response Body

OK

application/json
  1. response
data*array<>|null
has_more*boolean
next_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"}