Display scope

By default, read endpoints return everything on your account's subtree. An API key authenticates the account owner reading their own data — the same data the dashboard shows — so nothing is withheld from you.

If the response will be shown to the public, pass ?display=public:

curl "https://app.customer-alliance.com/api/v4/reviews?display=public" \
  -H "Authorization: Bearer ca_live_your_key_here"

Supported on GET /reviews and GET /reviews/{id} (reviews:read), and GET /insights/mentions (insights:read).

It excludes two groups: review portals whose content may not be republished (some license redisplay as a paid product, or have terms that have not been cleared for it), and sources whose authorship was never verified — reviews entered by hand (manual) and imported ones (upload: CSV uploads, and everything pushed through POST /reviews or POST /survey-responses).

Only the exact value public opts in. Any other value is ignored and you get the default, unfiltered behaviour — deliberately, so that a typo cannot silently withhold data. Rather than tracking which platforms may be republished yourself, use ?display=public and let the API apply the current set.

Upgrading an existing integration. GET /reviews previously withheld these platforms from every caller. It no longer does. If you use it to power anything the public sees, add ?display=public before upgrading — without it you will begin receiving reviews from platforms that may not be republished. If you use it for internal analytics, reporting or warehousing, you need to do nothing; you simply get more complete data.

Survey responses

Responses to your Customer Alliance surveys are never returned by GET /reviews, GET /reviews/{id} or GET /insights/mentions, with or without display=public. This is not a publishing restriction: a survey-bridged review is a representation of a response that GET /surveys/{id}/responses already serves, and returning it from both would make a consumer summing across them count the same feedback twice. To work with survey feedback, use the surveys endpoints.

Survey responses imported from another tool — pushed through POST /survey-responses or uploaded as a CSV — are the reverse: they are returned by the review endpoints as upload reviews, and the surveys endpoints do not list them. Either way, each response is served exactly once.

Hidden reviews

Hidden reviews are returned by GET /reviews, flagged is_hidden: true. Filter on that flag if you do not want them. (The public widget and certificate surfaces omit them entirely — a different surface, not this API.)