Overview of the Remote API integration
If you think we could be a good fit, read the steps and prerequisites for integrating with Remote below.
Pre-build checklist
Define your objectives
Decide what you intend to achieve with the API. For inspiration, visit our use cases and examples. To find the full list of endpoints and data fields available via the API, consult our API reference documents.
Assign internal resources
To complete the integration successfully, you will need a Remote account and a software developer to write the code.
Grant admin access to your developer
Your software developer will require admin access to your Remote account to generate an API token. To grant admin privileges in Remote click here.
Development checklist
Confirm you can access the sandbox
You will need to use our test environment to trial the API and verify 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. Note, you must have the company admin role in Remote to access this page.
Set up a test company
Within the sandbox, set up a company to use for testing. To create a company, click Sign Up and complete the sign-up flow. 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 one 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 an access token in hand, use it to make requests to the sandbox environment, following the example here. Sign in to your test company and verify that your test request succeeded.
Develop and validate your integration
Refer to our API developer resources and API reference documentation to develop and validate your integration with Remote. For technical support during the build phase, please contact our team at [email protected].
Deploy the integration to production
When you are satisfied that your API requests behave as intended, generate a production token and update the path for your requests to target your production company. More information on these steps can be found here.
Go-to-market checklist
Support your teams with the integration
Track queries and feedback from your team so your software developer can continuously refine and improve the integration.
Explore marketing opportunities with us
Collaborate with our marketing team to share your story, co-ordinate upcoming events, introduce your specialist to our audience and much more. Find full details about working with us here.
Stay informed about platform updates and enhancements
Sign up for our newsletter to receive the latest 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 currently no fees to use the Remote API.
No. The Remote API benefits tech-first customers who want to create bespoke workflows, automations and more. We encourage customers to review our requirements for integration, endpoints and use cases thoroughly before deciding whether to build an integration with Remote.
There are many possibilities – here are a few examples of what can be achieved:
Sync employee details to your preferred HRIS – Maintain a single view of your team’s data, regardless of location, enabling you to produce insightful reports.
Consolidate compensation data and reporting – Import the latest employee compensation figures from Remote into your company reports for richer 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 the Remote API’s capabilities. See the use cases for further ideas and inspiration on how to begin.
Yes. The Remote API was designed to be flexible to meet your needs.
Yes. A sandbox environment is available for experimenting with the API and validating results before making changes to your production company.
To access the sandbox environment:
Sign in to your Remote account.
Go 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 view this page.
After entering the sandbox, create a company to use for testing. To set up a company, click Sign Up and follow the sign-up flow. You will not be charged for any test employments created for this company.
Finally, generate an API token. An API token authenticates a user and permits 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 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 per minute. We are continually expanding the API to add new endpoints so customers can meet their automation goals. For example, endpoints for time off and expense data will be available soon. In the meantime, if you need 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 requests are triaged appropriately, we currently provide support by email only.
We have a dedicated team that supports co-marketing opportunities with customers. To discuss ideas and planning, contact our team at
.
Questions?
Have questions about the Remote API or need technical assistance? Contact our team below.