Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.expandarrayOptional
query.expand[]stringEach itemAdditional fields to include in the response.
One of: cost_centers, custom_fields

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a single contract — 200 response body

Referenced models: Retrieve a single contract — 200 response body

13 more schemas are linked from the tables above, on the schema pages.

Retrieve a single contract — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootContract template details.
idstringOptionalUnique identifier of a contract template.
titlestringOptionalTitle of a contract template
Retrieve a single contract — 200 response body — data client Client details associated with the contract
FieldTypePresenceDescription and constraints
$objectRootClient details associated with the contract.
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Minimum length: 5
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$
email (anyOf 2)nullAlternativeUser's email address.
Minimum length: 5
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$
full_namestringOptionalFull name of the client.
idstringOptionalUnique identifier of this resource.
legal_entityJSONOptionalLegal entity details of the client.
legal_entity (anyOf 1)ModelAlternativeExpand 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)nullAlternative
teamModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootCompensation and payment configuration for the contract.
amountJSONOptional
amount (anyOf 1)stringAlternativeAmount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
amount (anyOf 2)nullAlternativeAmount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
cycle_endJSONOptional
cycle_end (anyOf 1)JSONAlternative
cycle_end (anyOf 1) (anyOf 1)numberAlternativeDay of the cycle end
Format: double
cycle_end (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cycle_end (anyOf 2)nullAlternativeDay of the cycle end
Format: double
cycle_end_typeJSONOptionalCycle end type
cycle_end_type (anyOf 1)stringAlternativeCycle end type
Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
cycle_end_type (anyOf 2)nullAlternative
first_paymentJSONOptional
first_payment (anyOf 1)stringAlternativeFirst payment amount.
first_payment (anyOf 2)nullAlternativeFirst payment amount.
first_payment_dateJSONOptional
first_payment_date (anyOf 1)stringAlternativeFirst payment date.
first_payment_date (anyOf 2)nullAlternativeFirst payment date.
frequencystringOptionalScale of the invoice cycle.
gross_annual_salaryJSONOptional
gross_annual_salary (anyOf 1)stringAlternativeGross annual salary.
gross_annual_salary (anyOf 2)nullAlternativeGross annual salary.
gross_signing_bonusJSONOptional
gross_signing_bonus (anyOf 1)stringAlternativeGross signing bonus.
gross_signing_bonus (anyOf 2)nullAlternativeGross signing bonus.
gross_variable_bonusJSONOptional
gross_variable_bonus (anyOf 1)stringAlternativeGross variable bonus.
gross_variable_bonus (anyOf 2)nullAlternativeGross variable bonus.
scaleJSONOptional
scale (anyOf 1)stringAlternativeScale of the payment.
scale (anyOf 2)nullAlternativeScale of the payment.
Add external Id — 200 response body — cost centers item
FieldTypePresenceDescription and constraints
$objectRoot
allocation_percentageJSONOptional
allocation_percentage (anyOf 1)numberAlternativePercentage of the cost center allocation.
Format: double
allocation_percentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalCost center name.
numberstringOptionalCost center number.
Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
FieldTypePresenceDescription and constraints
$objectRootCustomized attributes on contracts (Employee ID, Project code, etc).
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the custom field.
id (anyOf 2)nullAlternativeUnique identifier of the custom field.
namestringOptionalCustom field property name.
valuestringOptionalCustom field property value.
Retrieve a single contract — 200 response body — data employment details
FieldTypePresenceDescription and constraints
$objectRootEmployment-related details for the contract.
days_per_weekJSONOptional
days_per_week (anyOf 1)numberAlternativeNumber of days per week.
Format: double
days_per_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours_per_dayJSONOptional
hours_per_day (anyOf 1)numberAlternativeNumber of hours per day.
Format: double
hours_per_day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
non_compete_clauseJSONOptional
non_compete_clause (anyOf 1)booleanAlternativeNon-compete clause state on the active EOR SOW. Null when not yet populated.
non_compete_clause (anyOf 2)nullAlternativeNon-compete clause state on the active EOR SOW. Null when not yet populated.
non_solicitation_clauseJSONOptional
non_solicitation_clause (anyOf 1)booleanAlternativeNon-solicitation clause state on the active EOR SOW. Null when not yet populated.
non_solicitation_clause (anyOf 2)nullAlternativeNon-solicitation clause state on the active EOR SOW. Null when not yet populated.
paid_vacation_daysJSONOptional
paid_vacation_days (anyOf 1)numberAlternativeNumber of paid vacation days.
Format: double
paid_vacation_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_periodJSONOptional
probation_period (anyOf 1)JSONAlternative
probation_period (anyOf 1) (anyOf 1)numberAlternativeProbation period in days.
Format: double
probation_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_period (anyOf 2)nullAlternativeProbation period in days.
Format: double
typestringOptionalType of employment.
Add external Id — 200 response body — invitations
FieldTypePresenceDescription and constraints
$objectRootInvitation email addresses for signing the contract.
client_emailJSONOptional
client_email (anyOf 1)stringAlternativeUser's email address.
client_email (anyOf 2)nullAlternativeUser's email address.
worker_emailJSONOptional
worker_email (anyOf 1)stringAlternativeUser's email address.
worker_email (anyOf 2)nullAlternativeUser's email address.
Add external Id — 200 response body — status
FieldTypePresenceDescription and constraints
$stringRootStatus 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

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.