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 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 company resources (company_admin)View forms (form:read)-
Company-scoped access token (assertion)Manage company resources (company_admin)View forms (form:read)-
Customer API tokenManage company resources (company_admin)View forms (form:read)-
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Country code according to ISO 3-digit alphabetic codes

Query Params
string

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.

≥ 1

Version of the form schema


Specific version number

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json