Deel: List of contracts

← contracts operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.contracts_getcontracts

Provider route: GET /contracts. Alter supplies the connection’s credentials and routing.

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 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()

Input

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

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

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

Official provider source