Remote API integration overview
Do you think we’re a good fit? For your reference, kindly review the steps and requirements for integrating with Remote below.
Pre-build preparations
Define your objectives
Decide what you aim to accomplish with the API. For inspiration, see our use cases and examples. To view the complete list of available endpoints and data fields through the API, consult our API reference documents.
Assign internal resources
To integrate successfully, you’ll need a Remote account and a software developer to write the integration code.
Grant admin access to your developer
Your software developer requires admin access to your Remote account in order to generate an API token. To grant admin access in Remote click here.
Development phase steps
Confirm you can access the sandbox
You’ll need access to our test environment to experiment with the API and validate results before making changes to your production company. To access the sandbox, log in to your Remote account and navigate to Integrations > Remote API > Access API. Please note, you must have the company admin role in Remote to access this page.
Set up a test company
When you’re in the sandbox environment, create a company for testing. To create one, click Sign Up and follow the sign up flow. Don’t worry — 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.
Execute a test request
With your access token, try some requests in the sandbox environment using the example here. Log in to your test company and confirm that your test request was successful.
Develop and validate your integration
Use our API developer resources and API reference documentation to construct and test your seamless integration with Remote. For technical assistance during development, please reach out to our team at [email protected].
Deploy your integration to production
When you’re confident your API requests behave as expected, generate a production token and update the path for your requests to start targeting your production company. More details on these steps can be found here.
Go-to-market steps
Support your teams in using the integration
Monitor questions and feedback from your team so your software developer can continuously iterate and improve the integration.
Explore marketing opportunities with us
Partner with our marketing team to share your story, collaborate on upcoming events, introduce your expert to our audience, and much more. Find out all the details about working with us here.
Stay updated on the latest platform news and enhancements
Sign up for our newsletter to receive insights 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 refine the API.
No. There are no fees to use our Remote API at this time.
No. The Remote API is intended for tech-first customers who wish to create bespoke workflows, automations, and more. We encourage customers to thoroughly review our requirements for integration, endpoints, and use cases before deciding whether to build an integration with Remote.
The possibilities are many — here are a few examples of what you can achieve:
Sync employee details to your preferred HRIS – maintain a unified view of your entire team’s data across locations so you can generate insightful reports.
Consolidate your compensation data and reporting – import the latest employee compensation data from Remote into your company reports for deeper insights.
Automate employee onboarding – save time and prevent onboarding delays by adding new hires to the Remote platform with a single click.
This is just the beginning of what the Remote API can do. Review these use cases for more ideas and inspiration on where to start.
Yes. We designed the Remote API to be as flexible as possible to meet your needs.
Yes. A sandbox environment is available if you want to experiment with the API and validate results before making changes to your production company.
To access the sandbox environment:
Log in to your Remote account.
Navigate to Integrations > Remote API > Access API. There you will find a link to the sandbox environment.
Please note, you must have the “company admin” role in Remote to access this page.
After entering the sandbox, create a company that you can use for testing. To create a company, click Sign Up and complete the sign up flow. Don’t worry, you won’t be charged for any test employments you create for this company.
Finally, generate an API token. An API token authenticates the user and allows them to make requests to the Remote API to access data for their company. You can generate an API 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 can have one token at a time. The token does not expire. If you no longer need it, you can revoke the token.
The Remote API restricts authenticated requests to 20 requests per minute. We continually work to add new endpoints to the Remote API so our customers can accomplish their automation goals. For example, endpoints to access time off and expense data through the API are coming soon! In the meantime, if you need an endpoint that we don’t have, please request it
here
.
If you encounter questions or technical issues during your API development, please email
. To ensure we triage requests appropriately, we currently provide support via email only.
We have a dedicated team to support ongoing co-marketing opportunities with our customers. For ideas and planning, please contact our team at
.
Questions?
Do you have questions about the Remote API or need technical assistance? Please contact our team below for assistance.