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 continually monitor, test, and iterate on the API.
No. There are no fees to use our Remote API at this time.
No. The Remote API is a benefit to tech-first customers who want to create bespoke workflows, automations, and more. We want our customers to thoroughly review our requirements for integration, endpoints, and use cases before they decide if they should build an integration with Remote.
The possibilities are boundless – here are just a few examples of what can be achieved:
Sync employee details to your preferred HRIS – Have a single view of your entire team’s data, regardless of location so that you can generate insightful reports.
Consolidate your compensation data and reporting – Feed the latest employee compensation data from Remote into your company reports for enhanced insights.
Automate employee onboarding – Save time and avoid onboarding delays by adding new hires to the Remote platform with a single click.
We’re just scratching the surface of what can be done with the Remote API. Take a look at these use cases for some more ideas and inspiration on where to start.
Yes. We developed the Remote API to be as flexible as possible to your needs.
Yes. There is a sandbox environment 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. Here you will find a link to the sandbox environment.
Please note, you need to have the “company admin” role in Remote to access this page.
Once in the sandbox environment, you will need to create a company that you can use for testing. To create a company, click Sign Up and go through 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 is a token that authenticates the user and allows them to make a request 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 the token, you can revoke it.
The Remote API limits the number of authenticated requests to 20 requests per minute. We’re also continually working to add new endpoints to the Remote API to ensure our customers can accomplish all of 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 have any questions or technical issues during your API development, please email
. To ensure we triage requests appropriately, we only offer email support at this time.
We have a dedicated team to support ongoing co-marketing opportunities with our customers. If you would like to discuss ideas and planning, please contact our team at
.
Questions?
Do you have questions about the Remote API or need technical assistance? Contact our team below.