R

Remote API

REST discovered

Details
URL
https://gateway.remote.com
Docs
https://developer.remote.com/reference/welcome-to-remote-api
Authentication
Customer API token bearer discovered Get token ↗
Authorization: Bearer <credential>

In the Remote dashboard, go to Company → Company Settings → Integrations & APIs → Integrations, open the Remote API card, and click Generate API token. Only company admins or company owners can create or revoke the token. See Obtaining access token and Quick Start Guide for Customers.

Partner OAuth access token oauth2_cc discovered Set up OAuth ↗
Authorization: Bearer <credential>

Use your partner CLIENT_ID and CLIENT_SECRET to call POST https://gateway.remote.com/auth/oauth2/token (or sandbox https://gateway.remote-sandbox.com/auth/oauth2/token) with HTTP Basic auth and grant_type=client_credentials. Remote returns a bearer access_token valid for 3600 seconds. See Client Credentials Flow for Partners.

Partner refresh token for company-authorized access oauth2 discovered Set up OAuth ↗
Authorization: Bearer <credential>

Register as a Remote API partner and obtain CLIENT_ID/CLIENT_SECRET, then send a company admin through Remote's OAuth authorization-code consent flow. After approval, exchange the returned code at POST https://gateway.remote.com/auth/oauth2/token (or sandbox) using HTTP Basic auth to receive a refresh_token, which you can later exchange for bearer access tokens. See Data sync for existing companies and Refresh Token Flow.

Partner-signed JWT assertion jwt discovered Get key ↗
Authorization: Bearer <credential>

Vetted partners create a JWT with iss set to their CLIENT_ID, sub bound to the Remote user or employment being acted for, aud matching Remote's auth server, and sign it with their partner CLIENT_SECRET. Exchange it at POST /auth/oauth2/token with grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer to receive a bearer access token. See Authorization Method — OAuth Assertion.