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.
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"]["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 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_contracts(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.after_cursor | string | Optional | |
query.limit | string | Optional | Default: 50 Pattern: ^[0-9]+$ |
query.order_direction | string | Optional | One of: asc, desc |
query.types | array | Optional | |
query.types[] | string | Each item | Type 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.statuses | array | Optional | |
query.statuses[] | string | Each item | Status 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_id | Model | Optional | Expand List users — request body — query filter |
query.legal_entity_id | Model | Optional | Expand List users — request body — query filter |
query.external_id | string | Optional | |
query.external_id_absent | string | Optional | |
query.countries | array | Optional | |
query.countries[] | string | Each item | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
query.currencies | array | Optional | |
query.currencies[] | string | Each item | Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
query.search | string | Optional | |
query.sort_by | string | Optional | One of: contract_title, worker_name |
query.expand | array | Optional | |
query.expand[] | string | Each item | Additional fields to include in the response. One of: cost_centers, custom_fields |
Referenced models: List users — request body — query filter
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 List of contracts — 200 response body |
Referenced models: List of contracts — 200 response body
Schemas
Section titled “Schemas”8 more schemas are linked from the tables above, on the schema pages.
List users — request body — query filter
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | array | Alternative | |
$ (oneOf 2)[] | string | Each item |
List of contracts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of contract objects. |
data[] | Model | Each item | Expand List of contracts — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Required within parent | Expand List of contracts — 200 response body — data item client Client information associated with the contract. |
cost_centers | array | Optional | List of cost centers associated with the contract. |
cost_centers[] | Model | Each item | Expand List of contracts — 200 response body — data item cost centers item |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Timestamp when the contract was created, in ISO-8601 format. Format: date-time |
created_at (anyOf 2) | null | Alternative | Timestamp when the contract was created, in ISO-8601 format. Format: date-time |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | Contract-level custom fields. Only returned when `expand=custom_fields` is provided. |
custom_fields (anyOf 1)[] | Model | Each item | Expand List of contracts — 200 response body — data item custom fields null item |
custom_fields (anyOf 2) | null | Alternative | Contract-level custom fields. Only returned when `expand=custom_fields` is provided. |
custom_fields (anyOf 2)[] | Model | Each item | Expand List of contracts — 200 response body — data item custom fields null item |
employment_details | Model | Optional | Expand List of contracts — 200 response body — data item employment details Employment-related details for the contract. |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | A unique identifier for the object provided by an external system. |
external_id (anyOf 2) | null | Alternative | A unique identifier for the object provided by an external system. |
fte_percentage | JSON | Optional | |
fte_percentage (anyOf 1) | JSON | Alternative | |
fte_percentage (anyOf 1) (anyOf 1) | number | Alternative | Full time percentage Format: double |
fte_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fte_percentage (anyOf 2) | null | Alternative | Full time percentage Format: double |
id | string | Required within parent | UUID of the contract. Minimum length: 1 |
invitations | Model | Required within parent | Expand List of contracts — 200 response body — data item invitations Details of invitations sent for signing the contract. |
is_archived | boolean | Required within parent | Indicates whether the contract is archived. |
is_shielded | boolean | Required within parent | Indicates whether the contract is shielded. |
notice_period | JSON | Optional | |
notice_period (anyOf 1) | number | Alternative | Number of days required to give notice before terminating the contract. Default: 0 Format: double Minimum: 0 |
notice_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
scale | JSON | Optional | |
scale (anyOf 1) | string | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.). |
scale (anyOf 2) | null | Alternative | The payment scale (e.g., hourly, weekly, monthly, etc.). |
signatures | Model | Required within parent | Expand List of contracts — 200 response body — data item signatures Signature information for the contract. |
status | Model | Required within parent | Expand List of contracts — 200 response body — data item status Status of a contract in Deel workflow. |
termination_date | JSON | Required within parent | |
termination_date (anyOf 1) | string | Alternative | Date when the contract is terminated, in ISO-8601 format. Format: date-time |
termination_date (anyOf 2) | null | Alternative | Date when the contract is terminated, in ISO-8601 format. Format: date-time |
title | string | Required within parent | Title of the contract. Minimum length: 1 |
type | string | Required within parent | Type 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_reports | string | Optional | Indicates who is responsible for providing regular reports. Known values: both, client, contractor |
worker | JSON | Optional | Worker information associated with the contract. |
worker (anyOf 1) | Model | Alternative | Expand List of contracts — 200 response body — data item worker Worker information associated with the contract |
worker (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination information for the response. |
cursor | string | Required within parent | Cursor for paginated results. |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of rows in the result set. Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List of contracts — 200 response body — data item client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client information associated with the contract. |
legal_entity | JSON | Optional | Legal entity information for the client. |
legal_entity (anyOf 1) | Model | Alternative | Expand List of contracts — 200 response body — data item client legal entity Legal entity information for the client |
legal_entity (anyOf 2) | null | Alternative | |
team | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Cost center object. |
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. |
List of contracts — 200 response body — data item custom fields null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contract custom field object. |
id | string | Optional | Public identifier of the custom field. |
name | string | Optional | Name of the custom field. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Value of the custom field for this contract. |
value (anyOf 2) | null | Alternative | Value of the custom field for this contract. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}