API Overview

Authentication

Requests can be authenticated via an API Key.

Create API Keys

To create an API Key you will require admin access to your organization that you are trying to access (see "Roles" below for a description). Click on the "gear" icon in the top right corner, then "Organization Settings", then "Manage API Keys" then "Create API Key". The API Key is treated as a password and once the window is closed you will no longer be able to retrieve it, make sure you copy it. It is recommended to keep it as a "read" only useless you specifically need otherwise.

Using the API key

A header with the key Authorization and the value APIKEY:ORGANIZATION {your key} where {your key} is substituted with your actual key. For example, APIKEY:ORGANIZATION abcdef1234567890,

There is a space between APIKEY:ORGANIZATION and {your key}

This will only give you access for that specific organization and all the Projects, Scenes, and Sessions of that Organization.

Currently, API Keys only have granularity to the Organization level, if you are interested in more granular control, please reach-out contact us.

Content Types

Most requests accept only JSON or do not expect a request body at all. The expected JSON request formats are documented where possible. Endpoints that upload raw files instead expect raw binary data and a content type that accurately reflects the file being uploaded. Similarly, endpoints that serve raw files will serve them with the content type they were uploaded with. All other routes return JSON or do not return with a response body.

Authorization

Each user has one or more roles. There are various scopes a role can have. Note that some roles can be observer roles which are read-only. There are various scopes a role can have. These scopes are a hierarchy; for example if you have Organization-level access, you will also have Project, and Scene level access.

Domain

This is the highest level permission a user can have. This is only available if you have a private label agreement with us. This scope allows access to domain settings.

Organization

The organization scope allows viewing/editing organization settings, such as adding/changing organization members (and their roles), viewing the organization audit log, configuring third-party connections, etc.

Project

Project scope allows viewing and editing project-level settings, and allows access to all scenes. This also covers access to Objectives, ExitPoll, Media Library, etc.

Scene

Allows viewing/editing a scene and its contents. This includes the scenes dynamic objects, sessions, aggregate data, and media.

User

All users have access to their own account, this allows things such as fetching their own information, updating their password, etc.

Additional API Documentation

We now offer comprehensive API documentation, please see our Postman docs.

If you can't find what you are looking for in the above link please contact us.

If you have a question or any feedback about our documentation please use the Intercom button (purple circle) in the lower right corner of any web page.