# Remote API Documentation

> The Remote API empowers our customers and partners to easily consolidate and share global employee data across platforms

This file lists one part of the documentation. The full index is at https://developer.remote.com/llms.txt.

## Guides: Get Started
- [Getting Started with Remote](https://developer.remote.com/docs/getting-started-with-remote.md): Start here to pick the right entry point into the Remote API — sync data, subscribe to events, or embed Remote in your product — then get sandbox access and make your first call.
- [Sandbox Quickstart](https://developer.remote.com/docs/sandbox-quickstart.md)
- [Your First API Call](https://developer.remote.com/docs/your-first-api-call.md): Make your first authenticated request to the Remote API and get real data back.
- [Introduction to the Remote CLI](https://developer.remote.com/docs/introduction-to-the-remote-cli.md)
- [Remote CLI Quick Start](https://developer.remote.com/docs/remote-cli-quick-start.md)
- [Changelogs](https://developer.remote.com/docs/changelogs.md): Remote API has a broad ecosystem to support partner integration. You can find where to locate changelogs and improvements for each component in the table below.

## Guides: Integration Essentials
- [Authentication](https://developer.remote.com/docs/authentication.md): Every Remote API request uses a bearer token. This page shows which token to get and how to send it.
- [Introduction to Webhooks](https://developer.remote.com/docs/introduction-to-webhooks.md)
- [Subscribing to Webhooks](https://developer.remote.com/docs/subscribing-to-webhooks.md)
- [Receiving Webhooks](https://developer.remote.com/docs/receiving-webhooks.md)
- [Verifying Webhooks](https://developer.remote.com/docs/verifying-webhooks.md)
- [Available Webhooks](https://developer.remote.com/docs/available-webhooks.md)

## Guides: Build with AI
- [Introduction to Build with AI](https://developer.remote.com/docs/introduction-to-build-with-ai.md)
- [Remote Agent Skills](https://developer.remote.com/docs/remote-agent-skills.md)
- [Introduction to Remote MCP](https://developer.remote.com/docs/introduction-to-remote-mcp.md): Learn what Remote.com MCP is, how it authenticates, which OAuth scopes it requires, and which clients it supports.
- [Remote MCP Quick Start](https://developer.remote.com/docs/quick-start-guide-2.md)
- [Build Integrations with AI](https://developer.remote.com/docs/build-integrations-with-ai.md)
- [Build Integrations Quick Start](https://developer.remote.com/docs/build-with-ai-quick-start.md)

## Guides: Sync your workforce
- [Sync your workforce data efficiently](https://developer.remote.com/docs/sync-workforce-data.md): Keep your systems in sync with Remote's workforce state the efficient way: load the full list once, then let webhooks push you the changes. Do not poll one employee at a time.
- [Creating Employees with Remote API](https://developer.remote.com/docs/creating-employees-with-remote-api.md)
  - [Prerequisites](https://developer.remote.com/docs/prerequisites.md)
  - [Create Employment](https://developer.remote.com/docs/create-new-employment.md)
    - [Employment Status](https://developer.remote.com/docs/employment-statuses.md)
    - [User Status](https://developer.remote.com/docs/user-status.md)
    - [Contract Status](https://developer.remote.com/docs/contract-status.md)
    - [Employment Lifecycle Stages](https://developer.remote.com/docs/employment-lifecycle-stages.md)
  - [Update and Invite Employment](https://developer.remote.com/docs/update-and-invite-employment.md)
  - [Cancel Onboarding](https://developer.remote.com/docs/cancel-onboarding.md)
- [Identity Verification](https://developer.remote.com/docs/identity-verification.md)
- [Offboarding an Employee](https://developer.remote.com/docs/offboarding-an-employee.md)

## Guides: Working with SDK
- [Introduction to Remote SDKs](https://developer.remote.com/docs/introduction-to-remote-sdks.md): 🚀 Accelerate Your Integration: How the Remote Flows SDK simplifies your development
- [Remote Flows SDK](https://developer.remote.com/docs/remote-flows-sdk.md)

## Guides: Working with Remote API
- [Environment Setup](https://developer.remote.com/docs/environment-setup.md)
- [How JSON Schemas Work](https://developer.remote.com/docs/how-json-schemas-work.md)
- [Date and Time Format](https://developer.remote.com/docs/date-and-time-format.md)
- [Money Format](https://developer.remote.com/docs/money-format.md)
- [Custom Fields](https://developer.remote.com/docs/custom-fields.md)
- [Working with Files](https://developer.remote.com/docs/working-with-files.md)
- [Magic Links for Passwordless Login](https://developer.remote.com/docs/magic-links-for-passwordless-login.md)
- [SSO Configuration](https://developer.remote.com/docs/sso-configuration.md)
- [Scopes](https://developer.remote.com/docs/scopes.md): Control exactly what your integration can read and write on a company's behalf.

## Guides: Embed in your product
- [Partner with Remote](https://developer.remote.com/docs/getting-started-for-partners.md)
- [Robust JSON Schemas for Partners](https://developer.remote.com/docs/empowering-our-partners-with-robust-json-schemas.md)
- [Rate Limit Policy](https://developer.remote.com/docs/rate-limit-for-partner.md)
- [Authorization for Partners](https://developer.remote.com/docs/authentication-for-partners.md)
  - [Authorization Code Flow](https://developer.remote.com/docs/authorization-code-flow.md): Let an existing Remote company grant your integration permission to manage their data on their behalf.
  - [Create a company with partner credentials](https://developer.remote.com/docs/getting-company-consent.md): Eligible partners can create a Remote company and receive access tokens for it in a single request.
  - [Refresh Token Flow](https://developer.remote.com/docs/refresh-token-flow.md)
  - [Client Credentials Flow for Partners](https://developer.remote.com/docs/client-credentials-flow-for-partners.md)
  - [Authorization Method — OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion.md)
- [Your own IDs on Remote records](https://developer.remote.com/docs/your-own-ids-on-remote-records.md): Store your own reference on a Remote record with partner_external_id, then find the record by it.
- [Build with Merge](https://developer.remote.com/docs/build-with-merge.md): Build a data sync integration with Remote via Merge
- [Employment Cost Estimation](https://developer.remote.com/docs/employment-cost-estimation.md)

## Guides: For Customers
- [Quick Start Guide for Customers](https://developer.remote.com/docs/quick-start-guide.md)
- [Obtaining access token](https://developer.remote.com/docs/authorization-for-customers.md)
- [Use Case and Examples](https://developer.remote.com/docs/use-case-and-examples.md)
- [Rate Limit Policy](https://developer.remote.com/docs/rate-limit.md)

## Guides: Country Management
- [Working with Countries API](https://developer.remote.com/docs/working-with-countries.md)

## Guides: Company Creation
- [Company creation, activation & Hiring Eligibility](https://developer.remote.com/docs/temporary-company-creation.md): This section outlines key processes on the Remote platform: creating, activating a company and ensuring compliance with EOR (Employer of Record) hiring eligibility.
  - [Company creation](https://developer.remote.com/docs/creating-a-company.md): In this guide, you will learn how to   - Request authorization from companies that you would like to manage on their behalf. - Create your first company and obtain a company-scoped access token at…
  - [EOR Hiring Eligibility](https://developer.remote.com/docs/eor-hiring-eligibility.md): This page describes the different signals we provide in the form of Webhooks to add visibility to the EOR hiring eligibility checks related to a company creation and employee onboarding.
  - [Company statuses](https://developer.remote.com/docs/company-statuses.md): This page explains the process for activating a company, including required address details and possible events

## Guides: Employment Payments
- [One-Time Bonus and Recurring Incentives](https://developer.remote.com/docs/working-with-incentives.md)
- [Working with Expenses](https://developer.remote.com/docs/working-with-expenses.md)

## Guides: Payroll
- [List Payroll Calendar](https://developer.remote.com/docs/list-payroll-calendar.md)
  - [List Company Payroll Calendar](https://developer.remote.com/docs/list-company-payroll-calendar.md)
  - [List EOR Payroll Calendar](https://developer.remote.com/docs/list-eor-payroll-calendar.md)
- [Send time & attendance to payroll with pay items](https://developer.remote.com/docs/send-time-and-attendance-to-payroll-with-pay-items.md): Send hours worked, overtime, leave and other pay inputs from your time and attendance system into Remote Payroll as pay items.
- [Sync time and attendance to payroll with your own IDs](https://developer.remote.com/docs/sync-time-and-attendance-to-payroll-with-your-own-ids.md): Send pay items from your time and attendance system with partner_external_id, so resends, changes and corrections never create duplicates.

## Guides: Financial Reporting
- [Pull your EOR cost breakdown for reconciliation](https://developer.remote.com/docs/pull-eor-cost-breakdown.md): Reconcile Remote EOR costs in your own accounting system — match what you pre-funded against what you actually paid, per employee, and book it to your GL.
- [Pull your PEO cost breakdown for reconciliation](https://developer.remote.com/docs/pull-peo-cost-breakdown.md): Bring Remote US PEO costs into your accounting system, per employee. PEO bills on actuals — a payroll invoice each pay run, plus a monthly service invoice.
- [Pull contractor invoices for AP](https://developer.remote.com/docs/pull-contractor-invoices-for-ap.md): Bring Remote contractor invoices into your accounts-payable workflow — contractors are paid via invoices, not payroll, so they're a separate, simpler pull.
- [Pull GL & payroll reports (Global Payroll)](https://developer.remote.com/docs/pull-gl-and-payroll-reports.md): Get Remote's balanced, account-mapped Global Payroll General Ledger out of Remote via the live Remote API — request, poll, and download after any completed payroll run, or interactively via the…

## Guides: HRIS
- [Working with Time Off](https://developer.remote.com/docs/working-with-time-off.md)
  - [Leave Policies](https://developer.remote.com/docs/leave-policies-summary.md)
- [Working with Timesheets](https://developer.remote.com/docs/working-with-timesheets.md)
- [Benefits Renewal](https://developer.remote.com/docs/benefits-renewal.md)