REremote-com
Employment Contracts

Get employment contract pending changes

Get all the pending changes (waiting for aproval or signature) for the employment contract.

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 contracts (contract:read)-
Company-scoped access token (assertion)Manage employments (employments)View contracts (contract:read)-
Customer API tokenManage employments (employments)View contracts (contract:read)-
get/v1/employment-contracts/{employment_id}/pending-changes

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/employment-contracts/{employment_id}/pending-changes
  • 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: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: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

Path parameters

employment_idstring required

Employment ID

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

{
  "data": {
    "pending_changes": [
      {
        "changes": {
          "contract.job_title": {
            "current": "Senior Engineer",
            "previous": "Engineer"
          }
        },
        "contract_id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
        "effective_at": "2021-07-15T18:18:17Z"
      }
    ]
  }
}

Changes

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