Remote Employment Management API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Employment Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
13 operations
across 9 paths,
and defines 54 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 Employment Management 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…
AccountsAccount
object
An Account
5 properties
1 required
ImportJobRowsResponse
object
1 property
1 required
AccountsLoginSyncedWith
string
Indicates which email type the account login is synchronized with.
EmploymentV2UpdateParams
object
Parameters for updating employment-level fields such as department, manager, work email, and external ID.
4 properties
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…
AccountsMinimalCompanyAdmin
object
3 properties
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
ListEmploymentsResponse
object
Response schema listing many employments
1 property
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
EmploymentShowResponse
object
Response containing the full employment record, including the termination date if the employment has an active offboarding.
1 property
1 required
DateTime
string
UTC date time in YYYY-MM-DDTHH:mm:ss format
AccountUserIntegrationUser
object
3 properties
3 required
ImportJobRowError
object
3 properties
1 required
UnprocessableEntityResponse
object
Country
object
A supported country on Remote
11 properties
3 required
CompleteOnboarding
object
Parameters to complete onboarding
1 property
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
PersonalDetails
object
Personal details for a user, includes sensitive information
15 properties
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…
ActionError
object
3 properties
3 required
EmploymentFullParams
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…
17 properties
BulkEmploymentCreateParams
object
Creates an asynchronous bulk employment job. Global Payroll activation is currently limited to Serbia (SRB) and requires the bulkgpproductactivation feature fl…
3 properties
2 required
MinimalUser
object
6 properties
2 required
MinimalEmployment
object
A lightweight employment representation used in list responses. Contains key identification, status, and type fields but not the full onboarding details or cou…
16 properties
14 required
BulkEmploymentImportJob
object
17 properties
12 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property
1 required
BulkEmploymentEmployeePayload
object
Employee payload. The nested fields must match the employment schema for the selected country. activateglobalpayroll is currently supported only for Serbia (SR…
2 properties
EmploymentBasicResponse
object
A lightweight employment representation returned after creation. Contains basic identification, country, and status fields but not the full onboarding details…
13 properties
Email
object
6 properties
1 required
File
object
A file associated with an employment, such as a contract, tax form, or identity document.
5 properties
4 required
UuidSlug
string
Identifier of the employment being terminated.
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
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…
NullableCountry
object
A supported country on Remote
11 properties
3 required
NullableDateTime
string
Optional UTC date time in YYYY-MM-DDTHH:mm:ss format
TaskDescription
object
Description and status of an onboarding task.
2 properties
EmploymentLifecycleStage
string
The stage of employment lifecycle. When it's onboarded means the employee is ready to commence or has already commenced.
CountryCode
string
Country code according to ISO 3166-1 3-digit alphabetic codes.
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
ImportJobRow
object
8 properties
3 required
OnboardingTasks
object
All tasks that need to be completed before marking the employment as ready
9 properties
9 required
BulkEmploymentImportJobResponse
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Remote publishes across the network.
