Getting Started
Countries

Show contractor contract details

Returns the contract details JSON Schema for contractors given a country.

When employment_id refers to a contractor employment, the schema's fields carry default values sourced from the contractor's current contract — the payment terms from the stored contract details or, absent those, the contractor's rate — so a new contract document form can be prefilled with them.

Those defaults are compensation data and require one of documents-management:create, people-contracts:create or hiring:update. Without them the schema is returned without default values, so the form renders blank rather than failing.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View forms (form:read)-
get/v1/countries/{country_code}/contractor-contract-details

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/countries/{country_code}/contractor-contract-details
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, form:read, company_admin, all:write, all:read)

Path parameters

country_codestring required

Country code according to ISO 3-digit alphabetic codes

Query parameters

employment_idstring

Employment ID. Tailors the schema to the employment (e.g. Contractor of Record fields) and, for a caller permitted to read the contractor's compensation, sets default values on its fields from the contractor's current contract.

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Response

Success

Example response

{
  "data": {
    "schema": {
      "properties": {
        "services_and_deliverables": {
          "description": "List of projects, project descriptions and deliverables that a Contractor shall provide",
          "maxLength": 3000,
          "minLength": 10,
          "title": "Services and Deliverables",
          "type": "string",
          "x-jsf-presentation": {
            "inputType": "textarea"
          }
        }
      },
      "required": [
        "services_and_deliverables"
      ],
      "type": "object",
      "x-jsf-order": [
        "services_and_deliverables"
      ]
    },
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.