Remote API integration overview
Wondering if we’re a good fit? Below are the steps and prerequisites for integrating with Remote.
Pre-build steps
Define your objectives
Decide what you aim to achieve with the API. use cases and examples. To view the complete list of endpoints and data fields available through the API, consult our API reference documents.
Assign internal resources
Successful integration requires a Remote account and a software developer to write the integration code.
Give your developer admin access
Your developer must have admin privileges on your Remote account so they can create an API token. To grant admin rights in Remote click here.
Development steps
Confirm access to the sandbox
You will need to use our test environment to try the API and validate results before altering your production company. To open the sandbox, sign in to your Remote account and navigate to Integrations > Remote API > Access API. Please note, you must hold the company admin role in Remote to view this page.
Set up a test company
After entering the sandbox, create a company for your tests. To do this, click Sign Up and follow the sign up flow. Rest assured, you will not be billed for any test employments you create for that company.
Obtain an API access token
An API token authenticates a user and permits requests to the Remote API for company data. You can generate a 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 the access token, send example requests to the sandbox environment as shown here. Sign in to your test company and verify that your test request completed successfully.
Develop and validate your integration
Refer to our API developer resources and API reference documentation to build and test your integration with Remote. For technical support during the build phase, contact our team at [email protected].
Release your integration to production
When you are satisfied your API calls function correctly, create a production token and update the request path so your calls are sent to your production company. More details on these steps can be found here.
Go-to-market steps
Provide support for teams using the integration
Keep an eye on team queries and feedback so your software developer can continuously refine and improve the integration.
Explore joint marketing opportunities with us
Partner with our marketing team to share your story, co-create events, introduce your specialist to our audience, and more. Learn all the details about collaborating with us here.
Stay informed about platform updates and new features
Subscribe to our newsletter for updates on remote work and global employment. Follow us on Twitter, LinkedIn, Instagram, and YouTube for the latest updates.
Frequently Asked Questions
Yes. We continuously monitor, test, and refine the API.
No. Using the Remote API is free at this time.
No. The Remote API is an option for tech-first customers seeking custom workflows, automations, and similar solutions. We encourage customers to carefully review our integration requirements, endpoints, and use cases before choosing whether to build an integration with Remote.
The possibilities are extensive – here are a few examples:
Sync employee details to your preferred HRIS – Maintain a unified view of your whole team’s data, irrespective of location, enabling richer reporting.
Consolidate compensation figures and reporting – Import current employee compensation data from Remote into your company reports for deeper insights.
Automate employee onboarding – Reduce delays and save time by adding new hires to Remote with a single click.
These examples only scratch the surface of the Remote API’s potential. Review the use cases for more ideas and inspiration on getting started.
Yes. The Remote API was designed to be flexible so it can accommodate 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.
Go to Integrations > Remote API > Access API. There you will find a link to the sandbox environment.
Please note, you must hold the “company admin” role in Remote to view this page.
After entering the sandbox, set up a company for testing. Click Sign Up and complete the sign up flow to create the company. Rest assured, you will not be charged for any test employments created for it.
Finally, generate an API token. An API token authenticates a user and authorizes requests to the Remote API for company data. 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 hold one token at a time. Tokens do not expire. Revoke a token if it’s no longer required.
The Remote API restricts authenticated requests to 20 requests per minute. We are continuously adding new endpoints so customers can meet their automation objectives. For example, endpoints for time off and expense data are coming soon. In the meantime, if you require an endpoint that is not yet available, please request it
here
.
If you have questions or encounter technical issues while developing the API, please email
. To ensure we triage requests appropriately, we provide support by email only at this time.
We have a dedicated team to manage co-marketing opportunities with customers. To discuss ideas and planning, please contact our team at
.
Questions?
Have questions about the Remote API or require technical assistance? Reach out to our team below.