/
Review API v3

Review API v3

Owned by KK (Unlicensed)
Last updated: Jul 09, 2024 by David Maicher

 

You will need an API key for authorizing your requests. You can request an API key from our Customer Support team. 
The API key must be passed in an HTTP header named X-CA-AUTH when requesting any of the API endpoints.

 

API endpoints

Getting the review information is a 3-step process, with two optional endpoints (review-subjects in the case when the account has multiple review configs linked to one API Key).

  • [Optional] Get Review Subjects- to be used in case of multi-location account. Depending on the API key, an account can have multiple review subjects. The API returns a unique identifier for a location.

  • [Optional] Get Survey questionnaires- to be used in case of multiple questionnaires for a single review subject. The API returns a unique identifier for the questionnaire and relates a particular questionnaire to the review subject.

  • Reviews- The API returns the review information generated by the CA surveys.

 

Get Review Subjects

Get Survey questionnaires

Reviews