ScubaTribe API V1

The ScubaTribe API is a RESTful api, which offers a variety of methods for interacting with your ScubaTribe account programatically.

The API opens up a realm of possibilities, including automatically integrating ScubaTribe with your booking system, displaying review content directly in your website, or attaching your customers feedback to their records in your CRM.
Example integrations, ideas, and code samples are available on the examples page.

Should you need any help or support when using the API, just send us a mail and we'll help you out ASAP.

If you have any ideas or suggestions, or have a finished Project you'd like us to showcase, just get in touch, we'd love to hear about it.

If you're developing for a ScubaTribe Partner, and not an individual client, you might want to refer to the partner documentation.

About ScubaTribe and this API

ScubaTribe is an automated system for gathering, interpreting and sharing feedback from real customers.
Feedback is accepted on an invitation only basis to ensure authenticity, and shared automatically across the clients social channels, on their ScubaTribe profile page and in a selection of 'badges' - images showing their review average and scores which can be added to websites, forum footers etc.

Requesting Feedback

All ScubaTribe reviews are by invitation only, thus increasing review trustworthiness and eliminating the ability of a competitor to influence a clients reviews.
A ScubaTribe review request is made either:
a) By adding a customers email address to our system, optionally with name, booking id and any other desired information (for example experience or booking partner)
b) By pre-generated Code - some customers prefer to pre-generate unique codes which they can add to their own post-visit emails.

The API provides methods to: make invitations by adding email addresses to the system, generate codes for integration in a booking system, view the status of all requests from the last 45 days, or check whether a specific code or request has been used.

It also provides methods for adding, removing and viewing your personal blacklist.

Feedback templates

With ScubaTribe you can set up feedback templates.
Each template can have different wording, language and questions, enabling the client to focus their feedback on specific customer groups, for example by course booked, or language spoken.

The API provides methods to read individual templates and list all templates.
To create or edit templates it is necessary to log into your ScubaTribe account.

Reviews

Once a customer receives a request (invitation), they can follow the link to leave a review.
(If using codes, at this point it would be 'activated' and assigned a request ID)

A review on ScubaTribe consists of a star rating, an optional location selection box, plus text about their experience and optional questions about themselves.
In addition to this, the client can choose to add 'extra' questions to a review or the 'about you' form.

The API provides methods to view individual reviews, including the customer details, extra questions and meta data, and to browse all a clients reviews.

A method is also provided to access the clients review summary - basic statistics on their aggregated feedback, including the average, count and number of recommendations.

For individual reviews methods are provided to add a comment (public reply) on behalf of the client, report abusive reviews, or vote them useful or not on behalf of the audience.
A method is also provided giving urls to share the review across social networks.

Profile

The clients profile is where all public facing information about the company is managed, this information is used to populate the review forms, and profile pages, and should be kept up to date.

The API provides methods to view the following aspects of a clients profile:
Basic information about the company, including logo, name, description, website, services offered etc.
Gallery Images, a selection of images which are displayed in a high resolution scrolling gallery on the profile page.
Contact points, multiple people or offices where the client can be contacted.
Locations, physical locations where the client operates. These can be displayed on the profile, or used as the data for the locations question in the review form, or both.

A method is also provided giving urls to share the profile across social networks.

Account

The API also provides a method to access the basic information regarding a clients acccount, including their current tarif and registered address.