Remote Sandbox API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sandbox. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
14 operations
across 12 paths,
and defines 46 schemas.
It is described by OpenAPI 3.0.0, at version 0.1.0.
Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.
The identity and technical contract details declared by the specification.
Remote Sandbox API declares
7 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (ClientToken).
It accepts HTTP bearer tokens (CustomerAPIToken).
It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes.
It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes.
It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes.
It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes.
By default, every request must be authenticated.
BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.OAuth2 — Authenticate using OAuth 2.0 protocol.OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.
ParameterError
object
3 properties
3 required
UserStatus
string
The status of the user account associated with this employment. - active: The user account is active and the user can log in. - created: The user account has b…
BenefitRenewalRequests.CreateBenefitRenewalRequestResponse
object
Create Benefit Renewal Request Response
1 property
1 required
BenefitRenewalRequests.MinimalBenefitRenewalResponse
object
2 properties
2 required
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
ProvisionalStartDate
string
Indicates the expected start date of the employee or contractor. Required for employees, but optional for contractors. Date format is in ISO8601 without the ti…
EmploymentUpdateParams
object
Required params to update an employment in the Sandbox environment. Currently supports setting the Employment Status to active and backdating the employment st…
2 properties
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
ConflictResponse
object
Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing…
1 property
DateTime
string
UTC date time in YYYY-MM-DDTHH:mm:ss format
RiskReserveProofOfPaymentResponse
object
1 property
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property
1 required
UnprocessableEntityResponse
object
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
Employment
object
Complete information of an employment, including all onboarding task statuses, country-specific form data (address, contract, administrative, etc.), and contra…
45 properties
28 required
EmploymentCreateParams
object
Description of the basic required and onboarding tasks params to create an employment. You do not need to include all onboarding tasks when creating or updatin…
8 properties
2 required
ShortId
string
Unique short identifier for the employment, automatically generated and visible in select areas of the Remote platform. Not intended as a replacement for the e…
ContractAmendment
object
A full contract amendment record, including the requested changes with their previous and current values.
9 properties
9 required
ActionError
object
3 properties
3 required
WebhookTriggerBillingParams
object
2 properties
2 required
ContractAmendmentStatus
string
The current status of a contract amendment request. - submitted: The amendment has been submitted and is awaiting Remote's review. - inreview: Remote is review…
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
EmploymentBasicResponse
object
A lightweight employment representation returned after creation. Contains basic identification, country, and status fields but not the full onboarding details…
13 properties
File
object
A file associated with an employment, such as a contract, tax form, or identity document.
5 properties
4 required
NullableMinimalBenefitTier
object
4 properties
3 required
UuidSlug
string
Identifier of the employment being terminated.
WebhookTriggerParams
object
Required params to trigger a webhook event in the Sandbox environment
BenefitRenewalRequests.BenefitRenewalRequest
object
10 properties
9 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties
1 required
PricingPlanDetails
object
Selected type of payment.
1 property
1 required
DateTimeIso8601
string
UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601
EmploymentCreationResponse
object
1 property
EmploymentSeniorityDate
string
The date the employee first started working for your company. If you don’t include a seniority date, the employee’s start date with Remote will be deemed as th…
EmploymentResponse
object
Response containing the full employment record after an update operation.
1 property
1 required
WebhookTriggerEmploymentParams
object
2 properties
2 required
EmploymentStatus
string
The current status of the employment record. - active: The employee is fully onboarded and actively working. - created: The employment has been created but onb…
ContractAmendmentResponse
object
Contract Amendment response
1 property
SalaryDecreaseDetails
object
The details of the salary decrease request if there is one
3 properties
TaskDescription
object
Description and status of an onboarding task.
2 properties
NullableCountry
object
A supported country on Remote
11 properties
3 required
BenefitRenewalRequests.CreateBenefitRenewalRequest
object
Benefit Renewal Request Form
1 property
1 required
EmploymentLifecycleStage
string
The stage of employment lifecycle. When it's onboarded means the employee is ready to commence or has already commenced.
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
OnboardingTasks
object
All tasks that need to be completed before marking the employment as ready
9 properties
9 required
RequestDetails
object
The details of the requested changes for the contract amendment.
5 properties
BenefitRenewalRequests.MinimalBenefitGroup
object
A lightweight benefit group reference used in renewal requests.
3 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Remote publishes across the network.
