Flag reason catalog

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.

Auth: Both — authentication. 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.

Request

  • 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{ data. } envelope.

When you give review_site_iddata 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 }.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional. Omit to get all sites grouped.

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json