REremote-com
Contract Amendments

List Contract Amendment. Requires a token issued via the authorization_code grant (company_manager role) — not usable with a client_credentials (integration) token.

List Contract Amendment requests.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employments (employments)View contract amendments (contract_amendment:read)Manage contract amendments (contract_amendment:write)
Company-scoped access token (assertion)Manage employments (employments)View contract amendments (contract_amendment:read)Manage contract amendments (contract_amendment:write)
Customer API tokenManage employments (employments)View contract amendments (contract_amendment:read)Manage contract amendments (contract_amendment:write)
get/v1/contract-amendments

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/contract-amendments
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: contract_amendment:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: contract_amendment:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Query parameters

employment_idstring

Employment ID

status'submitted' | 'in_review' | 'done' | 'canceled' | 'deleted'

The current status of a contract amendment request.

  • submitted: The amendment has been submitted and is awaiting Remote's review.
  • in_review: Remote is reviewing the amendment for compliance and feasibility.
  • done: The amendment has been approved and applied to the contract.
  • canceled: The amendment request was canceled before completion.
  • deleted: The amendment request was deleted.
Example:submitted

Contract Amendment status

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

Example response

{
  "contract_amendments": [
    {
      "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
      "id": "ba310525-9282-40c9-8977-14d844bf891a",
      "job_title": "Engineer",
      "reason_for_change": "annual_pay_adjustment",
      "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
      "requested_effective_date": "2023-04-13T13:35:06Z",
      "status": "submitted",
      "submitted_at": "2023-04-13T13:35:06Z"
    }
  ],
  "current_page": 1,
  "total_count": 1,
  "total_pages": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.