Remote API integration overview
Consider us a good match? Read the steps and prerequisites for integrating with Remote below.
Pre-build steps
Define your objectives
Decide what you intend to achieve with the API. For ideas, see our use cases and examples. To view the complete list of endpoints and available data fields in the API, consult our API reference documents.
Assign internal resources
For a successful integration, you will need a Remote account and a software developer to write the code.
Grant admin access to your developer
Your software developer must have admin rights on your Remote account to generate an API token. To grant your developer admin access in Remote click here.
Development steps
Confirm you can access the sandbox
You’ll need our test environment to try the API and verify results before changing your production company. To reach the sandbox, sign in to your Remote account and go to Integrations > Remote API > Access API. Note that you must hold the company admin role in Remote to view this page.
Create a test company
While in the sandbox environment, create a company to use for testing. To set up a company, click Sign Up and complete the sign-up flow. Don’t worry — you will not be charged for any test employments created for this company.
Obtain an API access token
An API token authenticates a user and permits requests to the Remote API to retrieve data for their company. Generate a token by going to 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 an access token, try sending requests to the sandbox environment using the example here. Sign in to your test company and verify the test request succeeded.
Develop and test your integration
Use our API developer resources and API reference documentation to build and test your seamless integration with Remote. For technical support during the build phase, please contact our team at [email protected].
Deploy your integration to production
When you are confident your API requests behave as expected, generate a production token and update the request path so calls are sent to your production company. More details on these steps can be found here.
Go-to-market steps
Support your teams with the integration
Track queries and feedback from your team so your software developer can continually iterate and enhance the integration.
Leverage marketing opportunities with us
Partner with our marketing team to tell your story, co-host events, introduce your specialist to our audience, and more. Find full details about working with us here.
Stay informed about 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 updates and news.
Frequently asked questions
Yes. We continuously monitor, test and refine the API.
No. Using the Remote API does not incur fees at this time.
No. The Remote API is offered to tech-first customers seeking bespoke workflows, automations and similar solutions. We recommend customers carefully review our integration requirements, endpoints and use cases before deciding whether to develop an integration with Remote.
The possibilities are numerous – here are a few examples of what you can achieve:
Sync employee details to your preferred HRIS – Maintain a single view of your whole team’s data across locations to produce insightful reports.
Consolidate compensation data and reporting – Import current employee compensation 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 is only the start of what the Remote API can do. Explore these use cases for further ideas and inspiration on where to begin.
Yes. The Remote API was built to be flexible and adaptable 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:
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 for testing by clicking Sign Up and completing the sign-up flow. You will not be charged for any test employments created for this company.
Lastly, generate an API token. An API token authenticates a user and permits requests to the Remote API for company data. You can create a token via 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 active at a time. Tokens do not expire; revoke them when no longer required.
The Remote API restricts authenticated requests to 20 requests per minute. We are continually adding new endpoints so customers can meet their automation needs. For example, endpoints for time off and expense data will be available soon! In the meantime, if you require an endpoint we do not yet provide, please request it
here
.
If you have questions or technical issues while developing the API, please email
. To ensure proper triage, we currently provide support via email only.
A dedicated team supports ongoing co-marketing opportunities. To discuss ideas and planning, contact our team at
.
Questions?
Have questions about the Remote API or need technical assistance? Contact our team below.