Get flag status

Overview

Get the current flag on a review, or a none state when the review has never been flagged.

Use it to show moderation state next to a review, or to check whether a flag you submitted has been actioned yet.

Prerequisites

• A bearer token in the Authorization header.
• The reviewId of the record you are targeting.

Base URL

Endpoint

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

Authentication

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

• Both partner-level and account-level users can call it.

Rate limit

• No rate limit.

Path parameters

How it works

• 200 always returns review_id, is_flagged and flag_status.
• When a flag exists, flag holds the full record and flag_status is one of pending, denied, approved_removed or submitted_to_platform.
• When no flag exists, flag is null and flag_status is none. This is still a 200, not a 404 — a review with no flag is a valid result, not a missing one.

Errors

Response

200 Flag exists · 200

{
  "data": {
    "review_id": 13383822,
    "is_flagged": true,
    "flag_status": "pending",
    "flag": {
      "id": 5012,
      "review_id": 13383822,
      "reason": "Review contains swear words…",
      "reason_identifier": "Profanity",
      "flag_reason_detail": "Customer used profane language about staff…",
      "flag_status": "pending",
      "flag_date": "2026-05-07T11:35:00.000000Z",
      "user_id": 42,
      "created_at": "2026-05-07T11:35:00.000000Z",
      "updated_at": "2026-05-07T11:35:00.000000Z"
    }
  }
}

200 No flag exists · 200

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

Example request

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