List AI drafts for a review

Overview

See every AI draft that's been generated for a review.

Use this to show a business owner the drafts they've already tried, or to re-use one.

You'll need the review_id.

Returns the drafts with their ids and text, newest first. Only drafts that were generated successfully are listed.

Prerequisites

A bearer token. See Authentication.
The review's id (review_id).

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/account/ai-responses

Authentication

Partner or Account token

The review must be inside your own account tree. A Partner token can list the drafts for reviews of any location under the partner; an Account token only for its own locations' reviews.
A review outside your tree is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

Parameter	In	Type	Required	Description
`review_id`	query	integer	Yes	The review whose drafts you want. Must exist and be inside your account tree.

Request body

None.

Request payload

None.

Response body

The drafts are in the data array. An empty array [] when the review has no drafts.

Field	Type	Description
`data[].id`	integer	The draft's id. Send it as `ai_response_id` when you post the reply with Post or edit a response.
`data[].review_id`	integer	The review the draft is for.
`data[].response`	string	The draft reply.
`data[].status`	string	`success`.
`data[].created_at`	string	When the draft was generated (ISO 8601, UTC).

Response payload

{
  "data": [
    {
      "id": 39,
      "review_id": 279309,
      "response": "Thank you for your positive rating. We appreciate your support and are glad to know you had a good experience with us.\n\nIf there's anything we can do to make your next visit even better, please don't hesitate to reach out. We look forward to serving you again soon.",
      "status": "success",
      "created_at": "2026-09-28T09:42:37.000000Z"
    }
  ]
}

Examples

Success payload

See Response payload.

The review has no drafts yet:

{
  "data": []
}

Error payload

422 Review outside your tree

{
  "message": "The selected review id does not belong to your company hierarchy.",
  "errors": {
    "review_id": [
      "The selected review id does not belong to your company hierarchy."
    ]
  }
}

422 Review doesn't exist

{
  "message": "The selected review id is invalid. (and 1 more error)",
  "errors": {
    "review_id": [
      "The selected review id is invalid.",
      "The selected review id does not belong to your company hierarchy."
    ]
  }
}

422 review_id missing

{
  "message": "The review id field is required.",
  "errors": {
    "review_id": [
      "The review id field is required."
    ]
  }
}

Status	Meaning
`200`	The review's drafts, or `[]` when it has none.
`401`	The token is missing, expired or invalid.
`422`	`review_id` is missing, doesn't exist or is outside your tree.
`500`	Unexpected server error.

Example request

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

Updated 18 days ago

Did this page help you?