Remote API integration overview

Think we’re a good fit? Read the steps and prerequisites for integrating with Remote below.

Pre-build steps

Define your goals

Decide what you want to achieve with the API. For inspiration, check out our use cases and examples. To view the full list of endpoints and available data fields exposed by the API, see our API reference documents.

Allocate internal resources

To integrate successfully, ensure you have a Remote account and a software developer to write the code.

Grant admin access to your developer

Your developer needs admin access to your Remote account so they can create an API token. To grant admin access in Remote click here.

Development steps

Confirm you can access the sandbox

Access our test environment to trial the API and verify results before making changes to your production company. To reach the sandbox, sign in to your Remote account and navigate to Integrations > Remote API > Access API. Note that you must have the company admin role in Remote to access this page.

Create a test company

After entering the sandbox, set up a company you can use for testing. Click Sign Up and complete the sign-up flow. You won’t be charged for any test employments you create for this company.

Obtain an API access token

An API token authenticates a user and permits requests to the Remote API to access company data. You can generate an API token by visiting Account Preferences> API management in your test environment and following the instructions here. Please note, this token will only work for API requests made to the sandbox environment.

Run a test request

With your access token, try some requests against the sandbox environment using the example here. Sign in to your test company and verify that your test request succeeded.

Build and test your integration

Use our API developer resources and API reference documentation to create and validate your integration with Remote. For technical help during development, please contact our team at [email protected].

Deploy your integration to production

When you’re satisfied your API requests behave correctly, generate a production token and update your request paths to send requests to your production company. More details on these steps can be found here.

Go-to-market steps

Support your teams using the integration

Track questions and feedback from your teams so your developer can keep iterating and enhancing the integration.

Make the most of marketing opportunities with us

Partner with our marketing team to tell your story, collaborate on upcoming events, introduce your specialist to our audience, and more. Find the full details about working with us here.

Stay up to date with the latest platform news and enhancements

Sign up for our newsletter to receive updates on remote work and global employment. Follow us on Twitter, LinkedIn, Instagram, and YouTube for the latest news and updates.

Frequently asked questions

Yes — we continuously monitor, test and improve the API.

Questions?

Have questions about the Remote API or need technical help? Contact our team below.

General questions

Developer support

Marketing support