Flag reason catalog

Overview

Get the flag-reason catalog used by the flagging dropdown. With review_site_id it returns a flat array of that site's reasons; without it, the full catalog grouped by review site.

Prerequisites

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

Base URL

Endpoint

GET /api/v1/reviews/flag/reasons

Authentication

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

• Who can call it: Partner and Account tokens.

• The endpoint applies no store/role scoping.

• The catalog is global and identical for any authenticated partner or account user.

Rate limit

• No rate limit.

Query parameters

• Query: review_site_id (integer, optional) — when present, limit reasons to that single review site (flat array). When you omit it, return all reasons grouped by site.

Response

When you give review_site_id — data is an array of ReviewSiteFlagReason rows:

• id (integer) — reason row id.
• reason_identifier (string) — short reason code.
• reason (string) — long platform-defined description.

When omitted — data is an array of per-site groups:

• review_site_id (integer) — site id.
• review_site_name (string|null) — site name (from reviewSite.name).
• reasons (array) — objects of { id, reason_identifier, reason }.

200 Single site · 200

{
  "data": [
    {
      "id": 47,
      "reason_identifier": "Profanity",
      "reason": "Review contains swear words, or has pornographic or sexually explicit language"
    },
    {
      "id": 48,
      "reason_identifier": "Harmful",
      "reason": "Review contains content that encourages…"
    }
  ]
}

Errors

Example request

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