Get a review
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.
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
review_id*stringThe review's ID.
^review_[0-7][0-9a-hjkmnp-tv-z]{25}$"review_01m6b3c4d5e6f7g8h9jkmnpqrs"The review.
application/json- response
A review of your organisation's page on Agoo Reviews, as agoo.reviews shows it. label says what Agoo checked
about the person behind it: verified_visit (Agoo recorded their visit or booking), invited (your
organisation invited them), phone_confirmed or email_confirmed. It never says the review is true. A removed
or withdrawn review keeps its ID and status, without its words.
id*ReviewIdA review ID on Agoo Reviews (TypeID with the review prefix).
^review_[0-7][0-9a-hjkmnp-tv-z]{25}$"review_01m6b3c4d5e6f7g8h9jkmnpqrs"object*"review""review"business_id*stringYour page's ID on Agoo Reviews (TypeID with the rbiz prefix).
place*status*string"published""removed""withdrawn"stars?integer1 <= value <= 5title?stringbody?stringvisit_month?stringThe month of the experience, as YYYY-MM.
language?stringlabel?string"verified_visit""invited""phone_confirmed""email_confirmed"proof_seen?booleanA moderator saw proof, such as a receipt, after a dispute.
reviewer_name?stringAs the page shows it: a display name such as Esi O., or initials where the kind of place asks.
reply?|nullurl?stringThe branch's page on agoo.reviews.
uriremoval_reason?|A removed review: the published reason.
published_at*|date-timeedited_at?|When the reviewer last changed it.
date-timecurl -X GET 'https://api.agoo.ardent.africa/v1/reviews/review_01m6b3c4d5e6f7g8h9jkmnpqrs'{ "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"}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.
Reply to a review POST
Posts your organisation's one public reply to a review, or changes it. It's checked by the same rules as reviews (no contact details, nothing that confirms someone was a patient or pupil); where the kind of place asks, it waits for a moderator before it appears (`reply.status` is `screening`). `review.replied` fires when it appears. Replying is free on every level. **Scope:** `reviews:write` · **Plan:** Growth, Pro and Enterprise in live mode; every plan in test mode.