Organisation

Allows a user to retrieve information for a specific organisation. Users are only allowed to retrieve information for organisations assigned to their API key.

Request

GET /v4/organisations/:trkref

This URL: /v4/organisations;trkref=D10 is deprecated. Please switch to the current URL above.

Parameters

Parameter Requirement
trkref mandatory
branch_code optional

Response

Attributes

Attribute Description
trkref identifier for the organisation
locale default locale for the organisation
name  
reviewables_path path to reviewables
customer_experience_reviews_path path to customer experience reviews
organisation_url_with_reviews link to open customer experience reviews in a lightbox on the organisation’s website
customer_experience_scores  
percentage_who_would_recommend  
number_of_retailer_rating_reviews  
percentage_happy_with_delivery  
number_of_retailer_delivery_reviews  
percentage_happy_with_customer_service  
number_of_retailer_service_reviews  

Example

GET /v4/organisations/D10

{
   "trkref":"D10",
   "locale":"en-GB",
   "name":"Demo Organisation",
   "reviewables_path":"/v4/organisations/D10",
   "customer_experience_reviews_path":"/v4/organisations/D10/customer_experience_reviews",
   "organisation_url_with_reviews": "http://www.reevoo.com/#/reevoomark/en-GB/retailer_reviews/D10",
   "customer_experience_scores":{
      "percentage_who_would_recommend":97,
      "number_of_retailer_rating_reviews":2020,
      "percentage_happy_with_delivery":96,
      "number_of_retailer_delivery_reviews":2001,
      "percentage_happy_with_customer_service":0,
      "number_of_retailer_service_reviews":0
   }
}