List reviews
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.
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: reviews:read
limit?integerHow many items to return, from 1 to 100.
1 <= value <= 10025cursor?stringThe next_cursor from the previous page. Leave it out for the first page.
length <= 512place_id?stringOnly this branch's reviews.
^rplace_[0-7][0-9a-hjkmnp-tv-z]{25}$"rplace_01m6a2b3c4d5e6f7g8h9jkmnpq"stars?integerOnly reviews with this many stars.
1 <= value <= 5label?stringOnly reviews with this label.
"verified_visit""invited""phone_confirmed""email_confirmed"published_after?stringOnly reviews published at or after this time.
date-timeunanswered?booleanOnly reviews without a reply.
A page of reviews.
application/json- response
data*array<>next_cursor*|Pass this as cursor to get the next page. null on the last page.
"b3BhcXVlLWN1cnNvcg"has_more*booleancurl -X GET 'https://api.agoo.ardent.africa/v1/reviews?limit=25'{ "data": [ { "id": "review_01m6b3c4d5e6f7g8h9jkmnpqrs", "object": "review", "business_id": "string", "place": { "id": "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq", "name": "string", "town": "string", "site_id": "string" }, "status": "published", "stars": 1, "title": "string", "body": "string", "visit_month": "string", "language": "string", "label": "verified_visit", "proof_seen": true, "reviewer_name": "string", "reply": { "body": "string", "status": "screening", "published_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "url": "http://example.com", "removal_reason": "string", "published_at": "2019-08-24T14:15:22Z", "edited_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "b3BhcXVlLWN1cnNvcg", "has_more": true}Get a download link GET
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.
Get a review GET
Returns one review of your organisation's page: published, or removed by a moderator (then without its words). **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode; every plan in test mode.