Remote API Integration Overview
Think we are a good match? Review the steps and requirements for integrating with Remote below.
Pre-build steps
Establish your goals
Determine what you want to accomplish using the API. For inspiration, check out our use cases and examples. To discover the full list of endpoints and data fields are available through the API, check out our API reference documents.
Allocate internal resources
For a successful integration, you will need a Remote account and a software developer to wite the code.
Provide admin access to your developer
Your software developer will need admin access to your Remote account so they can generate an API token. To give your software developer admin access in Remote click here.
Development steps
Ensure you can access the sandbox
You’ll need to access 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. Note, you must have the company admin role in Remote to access this page.
Create a test company
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.
Get an API access 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 and following the instructions here. Please note, this token will only work for API requests made to the sandbox environment.
Run a test request
Now that you have an access token, use it to try out some requests to the sandbox environment following the example here. Log in to your test company and confirm that your test request was successful.
Build 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
Once you’re confident that your API requests are working as expected, you can generate a production token and change the path for your requests to start sending requests to your production company. More details on these steps can be found here.
Go-to-market steps
Support your teams using the integration
Monitor questions and feedback from your team to help your software developer continually iterate and improve on the integration.
Take advantage of marketing opportunities with us
Work with our marketing team to share your story, collaborate on upcoming events, introduce your expert to our audience, and so much more! Find out all the details about working with us here.
Stay on top of the latest news and enhancements in our platform
Sign up for our newsletter to get the inside scoop on all things 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.