Remote Contracts API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
15 operations
across 14 paths,
and defines 47 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 Contracts 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.
ContractAmendmentFormResponse
object
Object with required and optional fields, its descriptions and suggested presentation
1 property
ParameterError
object
3 properties
3 required
IndexContractDocuments
object
Paginated list of contract documents
4 properties
4 required
ProbationExtensionFile
object
2 properties
2 required
ProbationExtensionStatus
string
The current status of a probation extension request. - submitted: The request has been submitted and is awaiting review. - inreview: Remote is reviewing the re…
EmploymentContract
object
9 properties
9 required
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
IndexContractDocumentsResponse
object
Paginated list of contract documents
1 property
1 required
ListContractAmendmentResponse
object
Response schema listing many contractamendments
1 property
EmploymentContractStatus
string
The status of the employment contract.
SignatoryStatus
string
Current signing status of this signatory
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
ContractAmendmentAutomatableResponse
object
Contract Amendment Automatable response
1 property
UnprocessableEntityResponse
object
Country
object
A supported country on Remote
11 properties
3 required
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…
ProbationCompletionLetterFile
object
Probation completion letter file
EmploymentContractPendingChangesResponse
object
1 property
1 required
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
ContractorContractDocumentStatus
string
The signing status of a contract document. - draft: The document is being prepared and has not been sent for signing. - awaitingsignatures: The document has be…
SignatoryType
string
The role of this signatory in the contract signing process
MinimalContractAmendment
object
A lightweight contract amendment representation used in list responses.
8 properties
7 required
EmploymentAgreementPreviewResponse
object
Return a base64 encoded Employment Agreement preview document
1 property
1 required
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
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…
ProbationExtension
object
A request to extend an employee's probation period. Requires Remote's review for compliance with local labor laws.
6 properties
6 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CreateContractAmendmentParams
object
3 properties
3 required
ProbationExtensionResponse
object
Probation Extension Response
1 property
GenericFile
string
A file represented as a base64-encoded string.
ContractDocumentItem
object
Contract document item in list response
7 properties
7 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties
1 required
ProbationCompletionLetter
object
Probation completion letter request
6 properties
6 required
CreateContractEligibilityParams
object
2 properties
2 required
DateTimeIso8601
string
UTC date time in [ISO 8601][] format. [ISO 8601]: https://en.wikipedia.org/wiki/ISO8601
ProbationCompletionLetterResponse
object
Probation completion letter request response
1 property
1 required
CreateProbationExtensionParams
object
7 properties
4 required
CreateProbationCompletionLetterParams
object
1 property
1 required
ContractPendingChanges
object
4 properties
3 required
ContractAmendmentResponse
object
Contract Amendment response
1 property
SalaryDecreaseDetails
object
The details of the salary decrease request if there is one
3 properties
ListEmploymentContractResponse
object
1 property
1 required
ListSignatory
object
A signatory on a contract document. For company and employee signatories, userid is provided. For other signatory types, userid is null.
8 properties
2 required
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
Compensation
object
3 properties
3 required
RequestDetails
object
The details of the requested changes for the contract amendment.
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Remote publishes across the network.
