Skip to content

Deel: List of contracts

Deel contracts.getContracts: arguments, response, policy and SDK examples.

← Contracts operations · Get started

Operation deel.contracts_getcontracts

Provider route: GET /contracts. 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"]["getContracts"]>[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.getContracts(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_contracts(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.after_cursorstringOptional
query.limitstringOptionalDefault: 50
Pattern: ^[0-9]+$
query.order_directionstringOptionalOne of: asc, desc
query.typesarrayOptional
query.types[]stringEach itemType of a contract.
One of: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, peo, unknown, employee, global_payroll, shield_msa, hris_direct_employee, contractor_outside_deel
query.statusesarrayOptional
query.statuses[]stringEach itemStatus of a contract in Deel workflow.
One of: 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, onboarded
query.team_idModelOptionalExpand List users — request body — query filter
query.legal_entity_idModelOptionalExpand List users — request body — query filter
query.external_idstringOptional
query.external_id_absentstringOptional
query.countriesarrayOptional
query.countries[]stringEach itemMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
query.currenciesarrayOptional
query.currencies[]stringEach itemMaximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
query.searchstringOptional
query.sort_bystringOptionalOne of: contract_title, worker_name
query.expandarrayOptional
query.expand[]stringEach itemAdditional fields to include in the response.
One of: cost_centers, custom_fields

Referenced models: List users — request body — query filter

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List of contracts — 200 response body

Referenced models: List of contracts — 200 response body

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

List users — request body — query filter
FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)stringAlternative
$ (oneOf 2)arrayAlternative
$ (oneOf 2)[]stringEach item
List of contracts — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentArray of contract objects.
data[]ModelEach itemExpand List of contracts — 200 response body — data item
pageModelRequired within parentExpand List of contracts — 200 response body — page
Pagination information for the response.

Referenced models: List of contracts — 200 response body — data item, List of contracts — 200 response body — page

List of contracts — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand List of contracts — 200 response body — data item client
Client information associated with the contract.
cost_centersarrayOptionalList of cost centers associated with the contract.
cost_centers[]ModelEach itemExpand List of contracts — 200 response body — data item cost centers item
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeTimestamp when the contract was created, in ISO-8601 format.
Format: date-time
created_at (anyOf 2)nullAlternativeTimestamp when the contract was created, in ISO-8601 format.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeContract-level custom fields. Only returned when `expand=custom_fields` is provided.
custom_fields (anyOf 1)[]ModelEach itemExpand List of contracts — 200 response body — data item custom fields null item
custom_fields (anyOf 2)nullAlternativeContract-level custom fields. Only returned when `expand=custom_fields` is provided.
custom_fields (anyOf 2)[]ModelEach itemExpand List of contracts — 200 response body — data item custom fields null item
employment_detailsModelOptionalExpand List of contracts — 200 response body — data item employment details
Employment-related details for the contract.
external_idJSONOptional
external_id (anyOf 1)stringAlternativeA unique identifier for the object provided by an external system.
external_id (anyOf 2)nullAlternativeA unique identifier for the object provided by an external system.
fte_percentageJSONOptional
fte_percentage (anyOf 1)JSONAlternative
fte_percentage (anyOf 1) (anyOf 1)numberAlternativeFull time percentage
Format: double
fte_percentage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fte_percentage (anyOf 2)nullAlternativeFull time percentage
Format: double
idstringRequired within parentUUID of the contract.
Minimum length: 1
invitationsModelRequired within parentExpand List of contracts — 200 response body — data item invitations
Details of invitations sent for signing the contract.
is_archivedbooleanRequired within parentIndicates whether the contract is archived.
is_shieldedbooleanRequired within parentIndicates whether the contract is shielded.
notice_periodJSONOptional
notice_period (anyOf 1)numberAlternativeNumber of days required to give notice before terminating the contract.
Default: 0
Format: double
Minimum: 0
notice_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scaleJSONOptional
scale (anyOf 1)stringAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.).
scale (anyOf 2)nullAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.).
signaturesModelRequired within parentExpand List of contracts — 200 response body — data item signatures
Signature information for the contract.
statusModelRequired within parentExpand List of contracts — 200 response body — data item status
Status of a contract in Deel workflow.
termination_dateJSONRequired within parent
termination_date (anyOf 1)stringAlternativeDate when the contract is terminated, in ISO-8601 format.
Format: date-time
termination_date (anyOf 2)nullAlternativeDate when the contract is terminated, in ISO-8601 format.
Format: date-time
titlestringRequired within parentTitle of the contract.
Minimum length: 1
typestringRequired within parentType of a contract.
Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, eor, unknown, peo, employee, global_payroll, shield_msa, hris_direct_employee, contractor_outside_deel
who_reportsstringOptionalIndicates who is responsible for providing regular reports.
Known values: both, client, contractor
workerJSONOptionalWorker information associated with the contract.
worker (anyOf 1)ModelAlternativeExpand List of contracts — 200 response body — data item worker Worker information associated with the contract
worker (anyOf 2)nullAlternative

Referenced models: List of contracts — 200 response body — data item client, List of contracts — 200 response body — data item cost centers item, List of contracts — 200 response body — data item custom fields null item, List of contracts — 200 response body — data item employment details, List of contracts — 200 response body — data item invitations, List of contracts — 200 response body — data item signatures, List of contracts — 200 response body — data item status, List of contracts — 200 response body — data item worker Worker information associated with the contract

List of contracts — 200 response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination information for the response.
cursorstringRequired within parentCursor for paginated results.
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows in the result set.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
List of contracts — 200 response body — data item client
FieldTypePresenceDescription and constraints
$objectRootClient information associated with the contract.
legal_entityJSONOptionalLegal entity information for the client.
legal_entity (anyOf 1)ModelAlternativeExpand List of contracts — 200 response body — data item client legal entity Legal entity information for the client
legal_entity (anyOf 2)nullAlternative
teamModelOptionalExpand List of contracts — 200 response body — data item client team
Team information for the client.

Referenced models: List of contracts — 200 response body — data item client legal entity Legal entity information for the client, List of contracts — 200 response body — data item client team

List of contracts — 200 response body — data item cost centers item
FieldTypePresenceDescription and constraints
$objectRootCost center object.
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.
List of contracts — 200 response body — data item custom fields null item
FieldTypePresenceDescription and constraints
$objectRootContract custom field object.
idstringOptionalPublic identifier of the custom field.
namestringOptionalName of the custom field.
valueJSONOptional
value (anyOf 1)stringAlternativeValue of the custom field for this contract.
value (anyOf 2)nullAlternativeValue of the custom field for this contract.

SDK function policy ID: deel.contracts_getcontracts. Catalog operation: contracts/list. 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.