Get a download link
Returns links to a ready file and its thumbnail that work for two minutes. Fetch a new link each time you
show the file rather than storing one.
- Opening an ID image or a selfie is recorded in the audit trail (
file.opened). - A file that isn't ready yet, or was deleted, returns
invalid_state.
Scope: files: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: files:read
file_id*stringThe file's ID.
^file_[0-7][0-9a-hjkmnp-tv-z]{25}$"file_01m4z8vge0fkktt139dhkf42gw"Short-lived download links.
application/json- response
url*stringPresigned URL for GET.
urithumbnail_url*|Presigned URL of the thumbnail, for photos. Otherwise null.
uriexpires_at*stringThe links stop working at this time (two minutes).
date-timecurl -X GET 'https://api.agoohq.com/v1/files/file_01m4z8vge0fkktt139dhkf42gw/download'{ "url": "https://files.example.com/f/7Kq2Xp4Lm9Rt?expires=1791230400&signature=8b2e7d", "thumbnail_url": "https://files.example.com/f/7Kq2Xp4Lm9Rt/thumbnail?expires=1791230400&signature=3f9c1a", "expires_at": "2026-10-15T08:02:00Z"}Retrieve a file GET
Returns a file's details and status. Poll it after uploading to see when the file is `ready`. Selfies are visible only to people who can read attendance, and to whoever uploaded them. ID images are visible only to Owners, Admins and Security leads signed in to Agoo (and to whoever uploaded one until it's processed): never to API keys or connected apps, which get `not_found`. **Scope:** `files:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
List reviews GET
Returns the published reviews of your organisation's page on Agoo Reviews, newest first, with each one's label (how it was verified) and your reply. Filter by branch, stars, label, date, or reviews without a reply. The reviewer appears as the page shows them, never with a contact detail. There's no way to hide, edit, reorder or delete a review through the API, as in the Console. **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business); every plan in test mode.