RArainbrand
Reviews

Get a Review

Changed on

Read a Review's progress and completed findings.

get/reviews/{id}

Request

  • Base URL
    https://www.rainbrand.com/api/v1
  • URL
    https://www.rainbrand.com/api/v1/reviews/{id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://www.rainbrand.com/api/auth/oauth2/authorize
      Token URL: https://www.rainbrand.com/api/auth/oauth2/token

Path parameters

idstring uuid required

Review ID.

Example:77be63b7-3c27-4b82-b023-af1f6f5a0d2b

Query parameters

boolean
OR
'0' | '1' | 'true' | 'false'
timeoutinteger

Max seconds to wait (default 120, max 295)

Response

OK

Example response

{
  "data": {
    "id": "77be63b7-3c27-4b82-b023-af1f6f5a0d2b",
    "status": "completed",
    "createdAt": "2026-10-01T12:00:00.000Z",
    "completedAt": "2026-10-01T12:00:45.000Z",
    "results": {
      "color": {
        "verdict": "pass",
        "note": "The yellow background matches Acme Inc.'s Atlas Pro palette.",
        "evidence": [
          {
            "url": "https://assets.acme.com/reviews/atlas-pro-color.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJ1c2VyLWFzc2V0cy9yZXZpZXdzL2F0bGFzLXByby1jb2xvci5wbmciLCJpYXQiOjE3OTA4NTYwNDUsImV4cCI6MTc5MTQ2MDg0NX0.dXYfgXwcU0j289gMXVxqRAm1dPABegVAvaEAh4qiFx8",
            "expiresAt": "2026-10-08T12:00:45.000Z"
          }
        ]
      },
      "copy": {
        "verdict": "pass",
        "note": "The headline reads \"Meet Atlas Pro\" and the call to action reads \"Explore Atlas Pro\".",
        "evidence": [
          {
            "url": "https://assets.acme.com/reviews/atlas-pro-copy.png?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1cmwiOiJ1c2VyLWFzc2V0cy9yZXZpZXdzL2F0bGFzLXByby1jb3B5LnBuZyIsImlhdCI6MTc5MDg1NjA0NSwiZXhwIjoxNzkxNDYwODQ1fQ.OJOV1zZ5Xwe9ovL-2KsJEjPsXw9gzO_F0Yc2nipfwno",
            "expiresAt": "2026-10-08T12:00:45.000Z"
          }
        ]
      }
    }
  }
}

Changes