Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Remote Contract Amendments API

The Contract Amendments API from Remote — 4 operation(s) for contract amendments.

Remote Contract Amendments API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contract Amendments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 5 operations across 4 paths, and defines 15 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/.

5 operations 4 paths 15 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Contract Amendments 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.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Contract Amendments 5
GET
/v1/contract-amendments/schema
Show form schema
get_v1_contract-amendments_schema 5 params → 200401404422
GET
/v1/contract-amendments
List Contract Amendment
get_v1_contract-amendments 5 params → 200401404422
POST
/v1/contract-amendments
Create Contract Amendment
post_v1_contract-amendments 2 params body → 200401404422
GET
/v1/contract-amendments/{id}
Show Contract Amendment
get_v1_contract-amendments_id 2 params → 200401404422
POST
/v1/contract-amendments/automatable
Automatable Contract Amendment
post_v1_contract-amendments_automatable 2 params body → 200401404422

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ContractAmendment (9 properties), MinimalContractAmendment (8 properties), RequestDetails (5 properties), ActionError (3 properties). Each schema is shown below with its type and property counts.

ContractAmendmentFormResponse
object
Object with required and optional fields, its descriptions and suggested presentation
1 property
ListContractAmendmentResponse
object
Response schema listing many contractamendments
1 property
MinimalContractAmendment
object
A lightweight contract amendment representation used in list responses.
8 properties 7 required
ParameterError
object
3 properties 3 required
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
CreateContractAmendmentParams
object
3 properties 3 required
ContractAmendmentResponse
object
Contract Amendment response
1 property
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…
SalaryDecreaseDetails
object
The details of the salary decrease request if there is one
3 properties
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
UnprocessableEntityResponse
object
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
RequestDetails
object
The details of the requested changes for the contract amendment.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-contract-amendments-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API