Get a review case
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.
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
case_id*stringThe case's ID.
^rcase_[0-7][0-9a-hjkmnp-tv-z]{25}$The case.
application/json- response
A service-recovery case on a review: the team's states and the customer's own answer, never the notes or the conversation.
id*string^rcase_[0-7][0-9a-hjkmnp-tv-z]{25}$object*"review_case""review_case"business_id*string^rbiz_[0-7][0-9a-hjkmnp-tv-z]{25}$review_id*ReviewIdA review ID on Agoo Reviews (TypeID with the review prefix).
^review_[0-7][0-9a-hjkmnp-tv-z]{25}$"review_01m6b3c4d5e6f7g8h9jkmnpqrs"place_id*string|nullstatus*string"open""action_taken""closed"opened_by*string"person""rule""customer"due_at*|date-timeoverdue*booleanhas_owner*booleancustomer_outcome*|The customer's own answer. A business closing a case never sets it.
"sorted""not_sorted""declined"nullcustomer_outcome_at*|date-timecustomer_outcome_public*booleanThe customer chose to show it under their review.
reopened*integercreated_at*stringdate-timeupdated_at*stringdate-timeclosed_at*|date-timecurl -X GET 'https://api.agoohq.com/v1/review-cases/string'{ "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"}