Reviews

Collected reviews and owner replies.

List reviews for the key's node subtree (newest first)

get

Requires reviews:read. Hidden reviews are included and marked is_hidden=true — filter on that flag to exclude them (unlike the public widget/certificate surfaces, which omit hidden reviews entirely).

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Query parameters

cursorstringOptional

Opaque pagination cursor from a prior response's next_cursor.

limitinteger · min: 1 · max: 100OptionalDefault: 25

Responses

200

A page of reviews.

application/json

next_cursorstring · nullableRequired

Pass as ?cursor= to fetch the next page; null on the last page.

has_morebooleanRequired

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

429

Rate limit exceeded. Honour the Retry-After header.

application/json

get/reviews

HTTPcURLJavaScriptPython

GET /api/v4/reviews HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "platform": "google",
      "external_id": "text",
      "author": null,
      "rating": null,
      "rating_normalized": null,
      "title": null,
      "text": null,
      "url": null,
      "language": null,
      "sentiment": null,
      "owner_reply": null,
      "replied_at": null,
      "reviewed_at": "2026-08-11T08:36:26.444Z",
      "node_id": "123e4567-e89b-12d3-a456-426614174000",
      "is_hidden": true
    }
  ],
  "next_cursor": null,
  "has_more": true
}

Get a single review by id

get

Requires reviews:read. Returns hidden reviews too (marked is_hidden=true).

Authorizations

bearerAuth

AuthorizationstringRequired

An API key created in Settings → API (ca_live_…).

Path parameters

idstring · uuidRequired

Responses

200

OK

application/json

A collected review. Hidden reviews are included and flagged is_hidden; the owner's own reply text is owner_reply.

idstring · uuidOptional

platformstringOptionalExample: google

external_idstringOptional

The review's id on the source platform.

authorstring · nullableOptional

Null when the review is anonymised.

ratingnumber · nullableOptional

Rating on a 0–5 scale.

rating_normalizednumber · nullableOptional

Rating normalised to 0–100.

titlestring · nullableOptional

textstring · nullableOptional

urlstring · nullableOptional

languagestring · nullableOptional

sentimentstring · nullableOptional

positive | neutral | negative | null.

owner_replystring · nullableOptional

replied_atstring · nullableOptional

reviewed_atstring · date-timeOptional

node_idstring · uuidOptional

is_hiddenbooleanOptional

401

Missing or invalid API key.

application/json

403

The key lacks the required scope, or the account's plan does not include it.

application/json

404

Not found or outside the key's scope.

application/json

get/reviews/{id}

HTTPcURLJavaScriptPython

GET /api/v4/reviews/{id} HTTP/1.1
Host: app.customer-alliance.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "platform": "google",
  "external_id": "text",
  "author": null,
  "rating": null,
  "rating_normalized": null,
  "title": null,
  "text": null,
  "url": null,
  "language": null,
  "sentiment": null,
  "owner_reply": null,
  "replied_at": null,
  "reviewed_at": "2026-08-11T08:36:26.444Z",
  "node_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_hidden": true
}