Check a flag's status

Overview

See where a review's flag stands: pending, accepted, or rejected by the site.

Use this to update your UI after flagging, or to follow up on flags that have been pending a while.

You'll need the review_id.

Returns the flag's current status, reason, and dates. A review with no flag still returns 200, with flag_status none and flag null.

Prerequisites

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

Base URL

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

Endpoint

GET /api/v1/reviews/{reviewId}/flag/status

Authentication

Partner or Account token

The review must be on a location inside your own account tree. A Partner token can check reviews of any location under the partner; an Account token only of its own locations.
A review outside your tree returns 404 Review not found, the same as a review that doesn't exist.

Rate limit

60 requests per minute, counted per user (the token’s user). See Rate limits.

Request parameters

Parameter	In	Type	Required	Description
`reviewId`	path	integer	Yes	The review's numeric id. Digits only.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`review_id`	integer	The review.
`is_flagged`	boolean	`true` when the review has a flag.
`flag_status`	string	`pending`, `denied`, `approved_removed` or `submitted_to_platform`; `none` when there's no flag.
`flag`	object or null	The flag, or `null` when there's none.
`flag.id`	integer	The flag's id.
`flag.review_id`	integer	The review.
`flag.reason`	string	The site's full description of the reason.
`flag.reason_identifier`	string	The reason's short name.
`flag.flag_reason_detail`	string or null	The explanation sent with the flag.
`flag.flag_status`	string	Same as `flag_status`.
`flag.flag_date`	string	When the review was flagged (ISO 8601).
`flag.user_id`	integer or null	The user recorded as the flagger.
`flag.created_at`	string	When the flag was created (ISO 8601).
`flag.updated_at`	string	When the flag last changed (ISO 8601).

Response payload

{
  "data": {
    "review_id": 279309,
    "is_flagged": true,
    "flag_status": "pending",
    "flag": {
      "id": 43,
      "review_id": 279309,
      "reason": "Review is off-topic, contains ads, or is gibberish or repetitive",
      "reason_identifier": "Low quality information",
      "flag_reason_detail": "This reviewer was never a customer and the claims are fabricated.",
      "flag_status": "pending",
      "flag_date": "2026-09-28T14:48:21.000000Z",
      "user_id": 3011,
      "created_at": "2026-09-28T14:48:21.000000Z",
      "updated_at": "2026-09-28T14:48:21.000000Z"
    }
  }
}

Examples

Success payload

The review has a flag: see Response payload.

The review has no flag:

{
  "data": {
    "review_id": 279310,
    "is_flagged": false,
    "flag_status": "none",
    "flag": null
  }
}

Error payload

404 Review not found

{
  "message": "Review not found",
  "status": "error",
  "errors": []
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Status	Meaning
`200`	The review's flag status, or `none` when it has no flag.
`401`	The token is missing, expired or invalid.
`404`	No review exists with that id, or it's outside your tree.
`429`	More than 60 requests in a minute from this user.
`500`	Unexpected server error.

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/reviews/279309/flag/status" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Updated 17 days ago

Did this page help you?