Remote API integration overview
Think we're a good fit? Read through the steps and requirements for integrating with Remote below.
Steps before building
Define your objectives
Decide what you want to achieve with the API. For ideas, see our use cases and examples. To see the full list of endpoints and data fields offered by the API, consult our API reference documents.
Assign internal resources
To integrate successfully, you'll need a Remote account and a developer to write the code.
Grant admin access to your developer
Your developer will need admin access to your Remote account to create an API token. To grant admin access in Remote click here.
Steps for development
Confirm access to the sandbox
You will need to use our test environment to try out the API and verify results before altering your production company. To reach the sandbox, sign in to your Remote account and go to Integrations > Remote API > Access API. Please note you must hold the company admin role in Remote to view this page.
Create a company for testing
After entering the sandbox, create a company to use for testing. To do so, click Sign Up and complete the sign-up flow. Don’t worry — you will not be charged for any test employments you create for this company.
Obtain an API access token
An API token authenticates a user and permits API requests to access company data. Generate a token in your test environment by going to Account Preferences> API management and following the instructions here. Please note this token will only work for API requests made to the sandbox environment.
Execute a test request
With your access token, try making requests to the sandbox environment using the example here. Sign in to your test company and verify that your test request succeeded.
Develop and test your integration
Use our API developer resources and API reference documentation to construct and validate your integration with Remote. For technical support while building, email our team at [email protected].
Roll out your integration to production
When you're satisfied the API requests behave correctly, create a production token and update the request path to target your production company. Further guidance is available here.
Market launch steps
Support your teams using the integration
Track questions and feedback from your team so your developer can continually refine and improve the integration.
Explore marketing opportunities with us
Collaborate with our marketing team to tell your story, co-host events, introduce your experts to our audience, and more. See full details about partnering with us here.
Keep up to date with the latest news and platform 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 continually monitor, test and iterate the API.
No. There are no fees to use the Remote API at present.
No. The Remote API is intended for tech-first customers wishing to create custom workflows, automations and similar solutions. We encourage customers to carefully review our integration requirements, endpoints and use cases before deciding whether to build an integration with Remote.
There are many possibilities – here are some examples:
Sync employee details to your preferred HRIS – Maintain a single view of your team's data across locations so you can produce insightful reports.
Consolidate compensation data and reporting – Import the latest employee compensation figures from Remote into your company reports for better insights.
Automate employee onboarding – Reduce delays and save time by adding new hires to the Remote platform with a single click.
This only scratches the surface of what the Remote API can do. See the use cases for further ideas and inspiration to get started.
Yes. The Remote API was developed to be flexible and adapt to your needs.
Yes. A sandbox environment is available for experimenting with the API and validating results before altering your production company.
To access the sandbox environment:
Sign in to your Remote account.
Go to Integrations > Remote API > Access API. You will find a link to the sandbox environment there.
Please note you must have the “company admin” role in Remote to access this page.
After entering the sandbox, create a company to use for testing. To do so, click Sign Up and complete the sign-up flow. Don’t worry — you will not be charged for any test employments you create for this company.
Finally, generate an API token. An API token authenticates a user and allows API requests to access company data. You can generate a token by visiting Account Preferences> API management in your test environment. Please note this token will only work for API requests made to the sandbox environment.
Each company admin user may have one token at a time. Tokens do not expire. If a token is no longer required, you can revoke it.
The Remote API restricts authenticated requests to 20 requests per minute. We are continually adding new endpoints to help customers meet their automation goals. For example, endpoints for time off and expense data are coming soon. In the meantime, if you require an endpoint we do not yet offer, please request it
here
.
If you have questions or technical issues during API development, please email
. To ensure appropriate triage, we only provide support via email at present.
We have a dedicated team to support co-marketing activities with customers. To discuss ideas and planning, please contact our team at
.
Questions?
Have questions about the Remote API or need technical help? Contact our team below.