List successful AI responses for a review

Overview

List every successfully-generated AI response row for a given review, newest first (status=success, ordered by id descending).

Prerequisites

  • A bearer token. Callable with Partner and Account tokens.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

GET /api/v1/account/ai-responses

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.

  • Who can call it: Partner and Account tokens.

  • The review_id query param must sit inside your own account tree. The review's store must resolve to a company that is the authenticated user's own person.company_id or a descendant of it.

  • Partner (bundle_id=1) and Account (bundle_id=3) roles share the endpoint. Only the reachable part of the account tree differs.

Rate limit

  • No rate limit.

Query parameters

  • Query: review_id (integer, required) — must be an existing review and belong to the auth company hierarchy.

Response

  • id (integer) — AiReviewResponse row id.
  • review_id (integer) — the review this response belongs to.
  • response (string) — the generated reply text.
  • status (string) — always success (the query filters to it).
  • created_at (datetime) — ISO-8601 timestamp.

200 Success · 200

{
  "data": [
    {
      "id": 901,
      "review_id": 123,
      "response": "Thanks for your honest feedback. I am sorry the visit did not meet expectations...",
      "status": "success",
      "created_at": "2026-05-26T11:30:00+10:00"
    },
    {
      "id": 887,
      "review_id": 123,
      "response": "We really appreciate your review! Our team works hard to deliver...",
      "status": "success",
      "created_at": "2026-05-25T14:12:00+10:00"
    }
  ]
}

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
422The request failed validation — the response names the fields
500Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/account/ai-responses?review_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?