API Documentation - Get That Review

Introduction

Welcome to the Get That Review API documentation. This guide will walk you through how to authenticate, interact with the endpoints, and make API requests to manage customer reviews effectively.

Base URL

All API requests should be made to:

Authentication

Before using the API, you must authenticate using a valid API key. Your API key can be found in:

Include the API key in the request headers:

Endpoints

1. Add a Customer to a List (Deprecated)

• Purpose: Adds a customer to a review request list.

• Deprecated: This endpoint is no longer recommended.

• Request Body (JSON):

• Required Fields: list_id

• Response:

  • 201: Customer added successfully

  • 404: List not found

  • 422: Validation error

2. Get Campaigns

• Purpose: Retrieves a list of active review campaigns.

• Response:

{
  "data": [
    {
      "id": "campaign_id",
      "name": "Campaign Name"
    }
  ]

3. Get Countries

• Purpose: Fetches a list of available countries.

• Response: JSON object containing country data.

4. Manage Organizations

a) Get All Organizations

• Purpose: Retrieves a list of all organizations.

• Authorization Required: Must have View organizations permission.

b) Create a New Organization

• Purpose: Creates a new organization.

• Request Body:

c) Get Organization Details

• Purpose: Fetches details of a specific organization.

• Response:

d) Update an Organization

• Purpose: Updates organization details.

• Request Body:

e) Delete an Organization

• Purpose: Deletes an organization.

• Response:

5. Get Review Sources

• Purpose: Fetches a list of review sources (Google, Facebook, etc.).

• Response:

{
  "data": [
    {
      "id": 1,
      "name": "Google",
      "url": "https://google.com/reviews",
      "logo": "google_logo.png",
      "available": true
    }
  ]

6. Get Reviews

• Purpose: Retrieves all collected reviews.

• Query Parameters:

  • rating: Filter by rating (1-5)

  • organization_id: Filter by organization ID

  • location_id: Filter by location ID

  • source_names: Filter by review sources

• Response:

{
  "data": [
    {
      "id": 1,
      "author": "Customer Name",
      "date": "2024-02-01",
      "rating": 5,
      "message": "Great service!",
      "source": "Google"
    }
  ]

7. Send Review Requests

• Purpose: Sends review request invites.

• Request Body:

• Response:

Error Handling

• 404: Resource not found

• 422: Validation errors (missing fields, invalid formats)

• 401: Unauthorized (invalid API key)

Conclusion

This guide provides an overview of the Get That Review API. Ensure you use a valid API key, structure requests correctly, and handle errors properly. For further details, refer to the full API documentation or contact support.