Download a document
Returns the file itself once its virus scan has passed, checked against its SHA-256 (sent as Repr-Digest).
Each download through the API is recorded in the organisation's audit trail. Responses are never cached.
409 while it's still being checked.
Scope: documents:read · Plan: Pro and Enterprise in live mode; every plan in test mode.
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 |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: documents:read
document_id*stringThe document's ID.
^hrdoc_[0-7][0-9a-hjkmnp-tv-z]{25}$"hrdoc_01m6k2a4c6e8g0j2r4n6q8s0tv"download?booleantrue: as an attachment to save; otherwise to show.
falseThe file.
response?filebinarycurl -X GET 'https://api.agoohq.com/v1/hr-documents/hrdoc_01m6k2a4c6e8g0j2r4n6q8s0tv/file'"string"Get a document GET
Returns one of a person's standard documents as metadata. **Scope:** `documents:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
List teams GET
Returns your teams with their members, newest first. A team is who a visitor comes to see when it isn't one person ("I'm here for Finance"), and who reception passes a waiting visitor to. **Scope:** `people:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.