Welcome

Welcome to our API Reference. This part of our documentation consists of several sections.

Overview

Overview of our API, including how it works and what can it be used for. This section also includes an overview of how Authentication works and the tools used for configuration.

Get started

The Get Started section includes guide on what you need to do to start using the API. It is divided into 4 major sub-sections:

• Prerequisites: Find out how to set up the application to start using the API. For example, API group or permissions setup.
• Authorization header: Guide on how to create an authorization header, which you will need to make an API call.
• Making your first call: Guide on how to make the first API call.
• Tips and best practices: API tips and best practices.

API reference

Information on API methods, including descriptions of all parameters and a TryIt function that lets you input your own values and execute a simulated API call.

Our API methods are split into the following groups: