Getting Started

Take your first steps to integrating with the API

The API is a REST API. Generally, we use resource URLs for our endpoints. We accept both form-encoded and JSON inputs, and return JSON-encoded results.

The API does not currently have a test environment.

Base URL

The URL for all the endpoints listed in the document follow this pattern:

https://YOUR_COMPANY_DOMAIN/api/ENDPOINT

So a GET request to list the users of an account would look like this:

GET https://portal.yourcompany.com/api/users

Headers

If you are sending JSON data to the API, you must add the Content-Type header to the request:

Content-Type: application/json

You should also set the Accept header to ensure that you receive a JSON response from the API:

Accept: application/json

Next Up: Authentication