Getting Started

Introduction

Welcome to Remote’s API documentation. Here you will find everything you need to easily consolidate and share global employee data across platforms.

The Remote API is composed of a set of RESTful resources protected by OAuth2. They follow the REST pattern using JSON messages as the only accepted format, and respect standard HTTP verbs and status codes.

What will you need?

Below is a list of everything you need to start using our API:

  • Received your CLIENT_ID and CLIENT_SECRET keys from Remote and stored them securely.
  • Ability to reach Remote's servers and fully authenticate using your credentials, according to the Authentication instructions we’ve provided.

How to get your CLIENT_ID and CLIENT_SECRET credentials?

Shortly after you signed and returned our NDA, you should have received two emails from Remote. The first granted you access to this developer documentation hub. The second granted access to your CLIENT_ID and CLIENT_SECRET keys via 1Password.

The 1Password access to your CLIENT_ID and CLIENT_SECRET keys is only valid for 7 days. Please be sure to save your credentials in a secure location.