List review invitations
Returns your organisation's review invitations, newest first: after visits and bookings, to customers, and
after-sale links. Each one's state is waiting, sent, not_sent (with skip_reason), stopped or
cancelled. Which invitation became which review is never shown, and contacts appear only as a masked line.
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
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 invitations.
^rplace_[0-7][0-9a-hjkmnp-tv-z]{25}$"rplace_01m6a2b3c4d5e6f7g8h9jkmnpq"A page of invitations.
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/review-invitations?limit=25'{ "data": [ { "id": "string", "object": "review_invitation", "place_id": "rplace_01m6a2b3c4d5e6f7g8h9jkmnpq", "source": "visit", "earns": "verified_visit", "recipient": "string", "channel": "email", "state": "waiting", "skip_reason": "no_contact", "visit_id": "string", "booking_id": "string", "send_after": "2019-08-24T14:15:22Z", "sent_at": "2019-08-24T14:15:22Z", "expires_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "b3BhcXVlLWN1cnNvcg", "has_more": true}Get review scores GET
Returns your page's score and each branch's, exactly as agoo.reviews shows them, with the spread of stars and of labels. A score shows from 3 reviews. What you pay never changes a score, an order or a page. **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode; every plan in test mode.
Invite customers to review POST
Invites customers to review a branch on Agoo Reviews, after a sale in your own system. Each needs an email address or a Ghanaian mobile number. They go at once (outside your quiet hours) on your organisation's channels, and the reviews they lead to are labelled Invited. Repeats within 90 days, people who asked not to be invited and your organisation's own people are left out, with why, in `left_out`. Invite every customer, never a chosen few: `declared` must be `true`. Invitations to people who checked in or booked go automatically from Agoo itself (labelled Verified visit) when your organisation turns them on. **Scope:** `reviews:invite` · **Plan:** Growth, Pro and Enterprise in live mode; every plan in test mode.