Deel: Retrieve a single contract
Deel contracts.getContract: arguments, response, policy and SDK examples.
← Contracts operations · Get started
Operation deel.contracts_getcontract
Provider route: GET /contracts/{contract_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["contracts"]["getContract"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.contracts.getContract(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.contracts.get_contract(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.expand | array | Optional | |
query.expand[] | string | Each item | Additional fields to include in the response. One of: cost_centers, custom_fields |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve a single contract — 200 response body |
Referenced models: Retrieve a single contract — 200 response body
Schemas
Section titled “Schemas”13 more schemas are linked from the tables above, on the schema pages.
Retrieve a single contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a single contract — 200 response body — data |
Referenced models: Retrieve a single contract — 200 response body — data
Add external Id — 200 response body — contract template Contract template details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract template details. |
id | string | Optional | Unique identifier of a contract template. |
title | string | Optional | Title of a contract template |
Retrieve a single contract — 200 response body — data client Client details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details associated with the contract. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Minimum length: 5 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$ |
email (anyOf 2) | null | Alternative | User's email address. Minimum length: 5 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$ |
full_name | string | Optional | Full name of the client. |
id | string | Optional | Unique identifier of this resource. |
legal_entity | JSON | Optional | Legal entity details of the client. |
legal_entity (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client |
legal_entity (anyOf 2) | null | Alternative | |
team | Model | Required within parent | Expand Add external Id — 200 response body — client Client details associated with the contract team Team information for the client organization. |
Referenced models: Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client, Add external Id — 200 response body — client Client details associated with the contract team
Add external Id — 200 response body — compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Compensation and payment configuration for the contract. |
amount | JSON | Optional | |
amount (anyOf 1) | string | Alternative | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. |
amount (anyOf 2) | null | Alternative | Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts. |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | Currency code. Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
cycle_end | JSON | Optional | |
cycle_end (anyOf 1) | JSON | Alternative | |
cycle_end (anyOf 1) (anyOf 1) | number | Alternative | Day of the cycle end Format: double |
cycle_end (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
cycle_end (anyOf 2) | null | Alternative | Day of the cycle end Format: double |
cycle_end_type | JSON | Optional | Cycle end type |
cycle_end_type (anyOf 1) | string | Alternative | Cycle end type Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH |
cycle_end_type (anyOf 2) | null | Alternative | |
first_payment | JSON | Optional | |
first_payment (anyOf 1) | string | Alternative | First payment amount. |
first_payment (anyOf 2) | null | Alternative | First payment amount. |
first_payment_date | JSON | Optional | |
first_payment_date (anyOf 1) | string | Alternative | First payment date. |
first_payment_date (anyOf 2) | null | Alternative | First payment date. |
frequency | string | Optional | Scale of the invoice cycle. |
gross_annual_salary | JSON | Optional | |
gross_annual_salary (anyOf 1) | string | Alternative | Gross annual salary. |
gross_annual_salary (anyOf 2) | null | Alternative | Gross annual salary. |
gross_signing_bonus | JSON | Optional | |
gross_signing_bonus (anyOf 1) | string | Alternative | Gross signing bonus. |
gross_signing_bonus (anyOf 2) | null | Alternative | Gross signing bonus. |
gross_variable_bonus | JSON | Optional | |
gross_variable_bonus (anyOf 1) | string | Alternative | Gross variable bonus. |
gross_variable_bonus (anyOf 2) | null | Alternative | Gross variable bonus. |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | Scale of the payment. |
scale (anyOf 2) | null | Alternative | Scale of the payment. |
Add external Id — 200 response body — cost centers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allocation_percentage | JSON | Optional | |
allocation_percentage (anyOf 1) | number | Alternative | Percentage of the cost center allocation. Format: double |
allocation_percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Cost center name. |
number | string | Optional | Cost center number. |
Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customized attributes on contracts (Employee ID, Project code, etc). |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the custom field. |
id (anyOf 2) | null | Alternative | Unique identifier of the custom field. |
name | string | Optional | Custom field property name. |
value | string | Optional | Custom field property value. |
Retrieve a single contract — 200 response body — data employment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment-related details for the contract. |
days_per_week | JSON | Optional | |
days_per_week (anyOf 1) | number | Alternative | Number of days per week. Format: double |
days_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_per_day | JSON | Optional | |
hours_per_day (anyOf 1) | number | Alternative | Number of hours per day. Format: double |
hours_per_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
non_compete_clause | JSON | Optional | |
non_compete_clause (anyOf 1) | boolean | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_compete_clause (anyOf 2) | null | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause | JSON | Optional | |
non_solicitation_clause (anyOf 1) | boolean | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause (anyOf 2) | null | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
paid_vacation_days | JSON | Optional | |
paid_vacation_days (anyOf 1) | number | Alternative | Number of paid vacation days. Format: double |
paid_vacation_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | number | Alternative | Probation period in days. Format: double |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Probation period in days. Format: double |
type | string | Optional | Type of employment. |
Add external Id — 200 response body — invitations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Invitation email addresses for signing the contract. |
client_email | JSON | Optional | |
client_email (anyOf 1) | string | Alternative | User's email address. |
client_email (anyOf 2) | null | Alternative | User's email address. |
worker_email | JSON | Optional | |
worker_email (anyOf 1) | string | Alternative | User's email address. |
worker_email (anyOf 2) | null | Alternative | User's email address. |
Add external Id — 200 response body — status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Status of a contract in Deel workflow. Known values: new, under_review, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment, onboarding, waiting_for_approval, onboarded |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.contracts_getcontract. Catalog operation: contracts/get. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read"]
Pinned headers: {"X-Version": "2026-01-01"}