List Employment Contract.

Get the employment contract history for a given employment. If only_active is true, it will return only the active or last active 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 type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employments (employments)	View contracts (contract:read)	-
Company-scoped access token (assertion)	Manage employments (employments)	View contracts (contract:read)	-
Customer API token	Manage employments (employments)	View contracts (contract:read)	-

get/v1/employment-contracts

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/employment-contracts
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

Query parameters

employment_idstring required

Employment ID

only_activeboolean

Only Active

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": {
    "employment_contracts": [
      {
        "activated_at": "2021-07-15T18:18:17Z",
        "amendment_contract_id": "e31adae1-contract-id-af5fba7dd803",
        "compensation": {
          "amount": 33000,
          "currency_code": "CAD",
          "wage_type": "salary"
        },
        "contract_details": {},
        "contract_id": "20a72f86-contract-id-9e4942a902ff",
        "country": {
          "alpha_2_code": "PT",
          "code": "PRT",
          "contractor_products_available": [
            "standard",
            "plus",
            "cor"
          ],
          "country_subdivisions": [
            {
              "code": "PT-06",
              "name": "Coimbra",
              "subdivision_type": "District"
            },
            {
              "code": "PT-11",
              "name": "Lisboa",
              "subdivision_type": "District"
            }
          ],
          "employment_agreement_preview_available": true,
          "eor_onboarding": true,
          "global_payroll_supported": true,
          "locked_benefits": "after_first_hire",
          "name": "Portugal",
          "region": "Europe",
          "subregion": "Southern Europe",
          "supported_json_schemas": [
            "additional_documents",
            "address_details",
            "administrative_details",
            "employment-basic-information",
            "bank_account_details",
            "contract_details",
            "emergency_contact"
          ]
        },
        "effective_at": "2021-07-15T18:18:17Z",
        "job_title": "Engineer",
        "status": "active"
      }
    ]
  }
}

Changes

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