# How to Connect to Remote

This guide walks you through generating an API token from Remote to connect your account.

Once the connection is live, the integration reads your Remote employees, companies, departments, time off and payrolls. It can also write back: creating and updating employees, adding departments, and creating, updating and cancelling time off requests. Companies and payrolls are read only.

- [Prerequisites](#prerequisites)
- [Generate Your API Token](#generate-your-api-token)
- [Environment](#environment)
- [Vault Connection Setup](#vault-connection-setup)
- [Revoking Tokens](#revoking-tokens)

## Prerequisites

- **Admin access**: only company admins or company owners can create and revoke API tokens
- **Active Remote account**: you must have an active Remote company account, or sandbox access if you are only testing (see [Getting sandbox access](#getting-sandbox-access))
- **One connection per company**: a Remote API token is scoped to a single company, so if you run several companies in Remote, generate a token in each one and create a separate connection for each

## Generate Your API Token

These steps generate a **production** token. If you are testing rather than connecting live data, get a sandbox token instead: see [Getting sandbox access](#getting-sandbox-access).

Follow these steps to generate an API token in Remote:

1. Log in to your Remote account.

2. Navigate to **Company → Company Settings → Integrations & APIs → Integrations**.

3. Click on the **Remote API** card.

4. Click the **Generate API token** button.

5. When prompted, enter a name for your API token (for example, "Apideck Integration").

6. Accept the **Remote API Terms of Use** agreement.

7. Your new token will appear in the table. Copy the token value: you will need this for the Vault setup.

## Environment

Remote API tokens are environment-specific:

- **Production tokens** start with `ra_live_` and work with the production API (`https://gateway.remote.com/`)
- **Sandbox tokens** start with `ra_test_` and work only in the sandbox environment (`https://gateway.remote-sandbox.com/`)

Make sure to select the matching environment in the Vault connection settings below.

### Getting sandbox access

You do not need a production account to try the integration first. Request sandbox access on Remote's [sandbox quickstart page](https://developer.remote.com/docs/sandbox-quickstart) and confirm the link Remote emails you. Remote then sends you a pre-seeded demo company and an `ra_test_` token by email.

## Vault Connection Setup

Enter your API token in Vault and select the appropriate environment:

- **API Key**: paste the API token you generated in Remote (it starts with `ra_live_` or `ra_test_`)
- **Environment**: select `Production` for live data or `Sandbox` for testing

Click **Save** to complete the connection.

You're connected now!

If the connection does not turn healthy, check that the token prefix and the selected environment match, then contact [Apideck Support](https://help.apideck.com/en/articles/7774658).

## Revoking Tokens

To revoke a token:

1. Navigate to **Company → Company Settings → Integrations & APIs → Integrations**
2. Click on the **Remote API** card
3. Locate the token you want to revoke in the table
4. Click the three-dot menu next to the token
5. Select the revoke option
6. Confirm the deletion

Revoked tokens cannot be recovered: generate a new token and update the connection in Vault if you still need access.