Skip to main content
Remote
v3.0.0
69 actions · 50 events · 4 auth methods
HRIS

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and create a Connector Profile in your project. See Setup Connector Profile.

API Token · Connector Profile

Generate an API token from your Remote account under Company settings > Integrations > Integrations & APIs > Remote API.

OAuth 2.0 · Connector Profile

Requires Remote partner OAuth credentials provisioned by Remote’s partnerships team. A company Owner or Admin approves a…

OAuth 2.0 Client Credentials · Connector Profile

Requires Remote partner OAuth credentials provisioned by Remote’s partnerships team. The token acts as the partner integ…

OAuth 2.0 JWT Assertion (Company Manager) · Connector Profile

Requires Remote partner OAuth credentials, and Remote must allow the integration to act on behalf of users. StackOne sig…
Optionally, configure receiving Events for Remote into StackOne.

Webhooks setup

3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

API Token · Link Account

OAuth 2.0 · Link Account

OAuth 2.0 Client Credentials · Link Account

OAuth 2.0 JWT Assertion (Company Manager) · Link Account

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

|
|
69 actions
Action
Description
Required scopes
List Benefit Offers
Retrieve a paginated list of all benefit offers
List Companies
List all companies that authorized your integration
Get Company
Retrieve details of a specific company by ID
Create Company
Create a new company
Update Company
Update an existing company
List Company Legal Entities
List all legal entities for a company
List Company Managers
List all company managers
Get Company Manager
Get details of a specific company manager
Create Company Manager
Create and invite a company manager
Delete Company Manager
Delete a company manager user
Get Contract Amendment Schema
Retrieve the contract amendment form schema for an employment
List Contractor Invoices
List all contractor invoices with filtering and pagination
Get Contractor Invoice
Retrieve details of a specific contractor invoice by ID
List Countries
List all countries supported by Remote API
List Country Holidays
Retrieve the list of public holidays for a specific country and year
Get Country Form Schema
Retrieve the JSON schema for a specific form type and country
List Custom Fields
List all custom field definitions
Create Custom Field
Create a new custom field definition
Get Custom Field Value
Get a custom field value for a specific employment
Update Custom Field Value
Update a custom field value for a specific employment
List Employment Custom Fields
List custom field values for a specific employment
List Departments
List all departments for a company
Create Department
Create a new department
List Employments
List all employments except deleted ones
Get Employment
Show all information of an employment
Create Employment
Create a new employment record
Update Employment
Update an existing employment record
List Expenses
List all expense records
Get Expense
Show a single expense record
Create Expense
Create an approved expense
Update Expense
Update an expense status
List Employment Files
List files associated with an employment
Download File
Download a file by ID
Upload File
Upload a file for an employment
List Incentives
Retrieve a paginated list of all incentives
Get Incentive
Retrieve details of a specific incentive by ID
Create Incentive
Create a new incentive for an employment
Update Incentive
Update an existing incentive
Delete Incentive
Delete an incentive
List Recurring Incentives
List all recurring incentives
Create Recurring Incentive
Create a monthly paid recurring incentive
Delete Recurring Incentive
Delete a recurring incentive
List Leave Policies Summary
List time off balances and entitlements for an employment
List Leave Policies Details
List leave policy configurations for an employment
List Offboardings
Retrieve a paginated list of all offboarding records
Get Offboarding
Retrieve details of a specific offboarding record
Create Offboarding
Initiate an offboarding process for an employment
List Payslips
Retrieve a paginated list of all payslips
Get Payslip
Retrieve details of a specific payslip by ID
List Payroll Runs
Retrieve a paginated list of all payroll runs
Get Payroll Run
Retrieve details of a specific payroll run by ID
Get Payroll Run Employee Details
Retrieve employee details for a specific payroll run
List Time Off Requests
Retrieve a paginated list of all time off requests
Get Time Off Request
Retrieve details of a specific time off request by ID
List Time Off Types
List all available time off types
Create Time Off Request
Create a new approved time off request
Update Time Off Request
Update a time off request
Approve Time Off Request
Approve a pending time off request
Decline Time Off Request
Decline a pending time off request
Cancel Time Off Request
Cancel an approved time off request
Approve Time Off Cancellation Request
Approve a time off cancellation request
Decline Time Off Cancellation Request
Decline a time off cancellation request
List Timesheets
List all timesheets
Get Timesheet
Get details of a specific timesheet
Approve Timesheet
Approve a submitted timesheet
List Webhooks
Retrieve a list of all registered webhook callbacks
Create Webhook
Register a new webhook callback
Update Webhook
Update a registered webhook callback
Delete Webhook
Delete a registered webhook callback

​
Events

|
50 events
Event
Description
Tags
Company Activated
Processes the Remote company.activated event.
Companies
Company Archived
Processes the Remote company.archived event.
Companies
Company Manager Created
Processes the Remote company.manager_created event.
Companies
Company Manager Updated
Processes the Remote company.manager_updated event.
Companies
Company Manager Deleted
Processes the Remote company.manager_deleted event.
Companies
Company Owner Changed
Processes the Remote company.owner_changed event.
Companies
Company Pricing Plan Updated
Processes the Remote company.pricing_plan.updated event.
Companies
Employment Updated
Processes the Remote employment.updated event.
Employments
Employment Status Updated
Processes the Remote employment.status.updated event.
Employments
Employment Account Updated
Processes the Remote employment.account.updated event.
Employments
Employment Details Updated
Processes the Remote employment.details.updated event.
Employments
Employment Personal Information Updated
Processes the Remote employment.personal_information.updated event.
Employments
Employment Work Email Updated
Processes the Remote employment.work_email.updated event.
Employments
Employment Employment Agreement Available
Processes the Remote employment.employment_agreement.available event.
Employments
Employment Start Date Changed
Processes the Remote employment.start_date.changed event.
Employments
Employment Benefits Selected
Processes the Remote employment.benefits.selected event.
Employments
Employment Onboarding Started
Processes the Remote employment.onboarding.started event.
Employments
Employment Onboarding Completed
Processes the Remote employment.onboarding.completed event.
Employments
Employment Onboarding Cancelled
Processes the Remote employment.onboarding.cancelled event.
Employments
Employment Onboarding Task Completed
Processes the Remote employment.onboarding_task.completed event.
Employments
Employment User Status Initiated
Processes the Remote employment.user_status.initiated event.
Employments
Employment User Status Invited
Processes the Remote employment.user_status.invited event.
Employments
Employment User Status Activated
Processes the Remote employment.user_status.activated event.
Employments
Employment User Status Deactivated
Processes the Remote employment.user_status.deactivated event.
Employments
Employment Contractor Of Record Termination Initiated
Processes the Remote employment.contractor_of_record_termination.initiated event.
Employments
Employment Contractor Of Record Termination Executed
Processes the Remote employment.contractor_of_record_termination.executed event.
Employments
Employment Contractor Of Record Termination Cancelled
Processes the Remote employment.contractor_of_record_termination.cancelled event.
Employments
Contract Termination Date Reached
Processes the Remote contract.termination_date_reached event.
Employments
Expense Submitted
Processes the Remote expense.submitted event.
Expenses
Expense Approved
Processes the Remote expense.approved event.
Expenses
Expense Declined
Processes the Remote expense.declined event.
Expenses
Expense Reimbursed
Processes the Remote expense.reimbursed event.
Expenses
Expense Updated
Processes the Remote expense.updated event.
Expenses
Expense Deleted
Processes the Remote expense.deleted event.
Expenses
Offboarding Submitted
Processes the Remote offboarding.submitted event.
Offboardings
Offboarding Review Started
Processes the Remote offboarding.review_started event.
Offboardings
Offboarding Submitted To Payroll
Processes the Remote offboarding.submitted_to_payroll event.
Offboardings
Offboarding Completed
Processes the Remote offboarding.completed event.
Offboardings
Offboarding Done
Processes the Remote offboarding.done event.
Offboardings
Offboarding Deleted
Processes the Remote offboarding.deleted event.
Offboardings
Payslip Released
Processes the Remote payslip.released event.
Payslips
Timeoff Requested
Processes the Remote timeoff.requested event.
Time Off
Timeoff Approved
Processes the Remote timeoff.approved event.
Time Off
Timeoff Declined
Processes the Remote timeoff.declined event.
Time Off
Timeoff Cancellation Requested
Processes the Remote timeoff.cancellation_requested event.
Time Off
Timeoff Canceled
Processes the Remote timeoff.canceled event.
Time Off
Timeoff Date Changed
Processes the Remote timeoff.date_changed event.
Time Off
Timeoff Updated
Processes the Remote timeoff.updated event.
Time Off
Timeoff Started
Processes the Remote timeoff.started event.
Time Off
Timeoff Taken
Processes the Remote timeoff.taken event.
Time Off