List review platforms

GET/api/v1/review-platforms

scope reviews:read

The public review sites a happy customer is pointed to after rating — Google, Facebook and so on — in the order the business arranged them.

Request

curl "https://your-crm.example.com/api/v1/review-platforms" \
  -H "Authorization: Bearer $RAABTA_API_KEY"

Response · 200 OK

{
  "data": [
    {
      "id": "a9b8c7d6-e5f4-4a3b-9c2d-1e0f9a8b7c6d",
      "platform": "google",
      "label": "Google",
      "url": "https://g.page/r/example/review",
      "sort_order": 0,
      "active": true
    }
  ]
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`platform`required	`string (enum)`	Which review site`googlefacebooktripadvisortrustpilotyelpcustom`
`label`required	`string \| null`	The name shown on the button
`url`required	`string`	Where the customer is sent to leave a public review
`sort_order`required	`integer`	Position in the list, lowest first
`active`required	`boolean`	Whether it is currently offered

Errors

Status	Code	When
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.