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 theurn:ietf:params:oauth:grant-type:jwt-bearergrant 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 company resources (company_admin) | View forms (form:read) | - |
| Company-scoped access token (assertion) | Manage company resources (company_admin) | View forms (form:read) | - |
| Customer API token | Manage company resources (company_admin) | View forms (form:read) | - |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||