Admin API

Overview

The Admin API is designed to allow larger organizations to interact with their locations in a programmatic way.

The Admin API is designed for Customers looking to manage a large number of locations or API Partners who want to integrate at a system level. Most users will not need to use these APIs - if you want to discuss your integrations plans with our engineers get in touch at [email protected].

Common use cases for this API include:

• Integrating review data with a central reporting dashboard
• Automatically creating new locations based on internal tools
• Manage user permissions centrally

Authentication

The Admin API uses a standard Opinous Token as documented in the REST Authentication section.

Admin API endpoints require "Admin" permissions on the Token. Learn more about granting permissions to API tokens here.

Endpoints

List Locations

This endpoint allows you to list the Locations attached to the Organization.

URL

  GET - https://api.opinous.com/v1/locations

Request Parameters

Headers

Response Body

[
  {
    "id": "87f64071-e090-48cb-9bbc-532dc701e55a",
    "name": "My Opinous Test Location",
    "color_code": "6B5AED",
    "icon": "far fa-map-marker-alt",
  }
]