List review cases
Returns your page's service-recovery cases, newest first: who opened each (your team, the page's rule for 1 and
2 star reviews and serious topics, or the customer), its state, whether it has an owner and is overdue, and the
customer's own answer (sorted, not_sorted or declined). Never the team's notes or the conversation.
Cases are read here and worked in the Console or the business area.
Scope: reviews:read · Plan: Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); 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 |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As above, on any level: it reads the business's reviews and checks every write without saving it |
Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers. 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 <= 512status?string"open""action_taken""closed"place_id?stringOnly this branch's cases.
^rplace_[0-7][0-9a-hjkmnp-tv-z]{25}$"rplace_01m6a2b3c4d5e6f7g8h9jkmnpq"A page of cases.
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.agoohq.com/v1/review-cases?limit=25'{ "data": [ { "id": "string", "object": "review_case", "business_id": "string", "review_id": "review_01m6b3c4d5e6f7g8h9jkmnpqrs", "place_id": "string", "status": "open", "opened_by": "person", "due_at": "2019-08-24T14:15:22Z", "overdue": true, "has_owner": true, "customer_outcome": "sorted", "customer_outcome_at": "2019-08-24T14:15:22Z", "customer_outcome_public": true, "reopened": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "closed_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "b3BhcXVlLWN1cnNvcg", "has_more": true}Remove a catalogue item DELETE
Takes an item off your page. Reviews that name it keep doing so as they were. `item.removed` fires. A test key checks it and changes nothing. **Scope:** `reviews:write` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.
Get a review case GET
Returns one case on your page, within your key's branches. **Scope:** `reviews:read` · **Plan:** Growth, Pro and Enterprise in live mode (Reviews Business or Reviews Enterprise for an Agoo Reviews key); every plan in test mode.