Contract Amendments

Show form schema

Returns the json schema of the contract_amendment form for a specific employment. This endpoint requires a company access token, as forms are dependent on certain properties of companies and their current employments.

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 type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage 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 token	Manage employments (employments)	View contract amendments (contract_amendment:read)	Manage contract amendments (contract_amendment:write)

get/v1/contract-amendments/schema

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/contract-amendments/schema
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 required

The ID of the employment concerned by the contract amendment request.

country_codestring required

Country code according to ISO 3-digit alphabetic codes.

form'contract_amendment'

Name of the desired form

integer

Specific version number

'latest'

Use latest version

Version of the form schema

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

dataobject

Example response

{
  "data": {
    "additionalProperties": false,
    "properties": {
      "effective_date": {
        "description": "If you want to backdate this amendment, we cannot guarantee your preferred date is possible due to country-specific laws.\nPlease enter your preferred date, and we’ll reach out to you if there are any issues.\n",
        "title": "Effective date of change",
        "type": "date"
      },
      "job_title": {
        "description": "What is their job title? E.g. Product designer",
        "maxLength": 255,
        "title": "Job title",
        "type": "string"
      }
    },
    "required": [
      "job_title",
      "effective_date"
    ],
    "type": "object"
  }
}

Changes

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