1. Help Center
  2. API Documentation

Rhythm API Overview

Welcome to the Rhythm API.

The API is built to allow you to create functional integration quickly and easily. The Rhythm API is organized around REST - if you've interacted with a RESTful API already, many of the concepts will be familiar to you. All API calls to Rhythm should be made to https://api.rhythm.cloud (except for first time authorization, i.e. when the first authorization code is issued). We use many standard HTTP features, like HTTP verbs, which can be understood by many HTTP clients. JSON will be returned in all responses from the API, including errors. The APIs are designed to have predictable, straightforward URLs and to use HTTP response codes to indicate API errors.

Prerequisites

In order to use the API, your company must first be enabled for API Access by Rhythm Systems. To have your company enabled, please contact Rhythm Systems at help@rhythmsystems.com.

Authentication and Accounts

The API supports authentication via OAuth 2.0. For a Rhythm account (i.e. user login) to be used for API Access, it must be granted API Access by your designated Company Admin, or Rhythm Systems. See our Authentication Overview for more details about authenticating requests.

Once your company and your user account has been granted API Access, you will gain access to the API Admin section of Rhythm, accessible from the menu when you click your user thumbnail in the upper right corner of Rhythm. If you do not see the option, and have verified that your company and your user account have both indeed been granted API Access, you may need to refresh your browser, or log out and login again.

Screen Shot 2019-03-26 at 3.29.08 PM

Next Step -> API Clients