Deel: List contract amendments
Deel contractorAmendments.getContractAmendments: arguments, response, policy and SDK examples.
← Contractor amendments operations · Get started
Operation deel.contractoramendments_getcontractamendments
Provider route: GET /contracts/{contract_id}/amendments. 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["contractorAmendments"]["getContractAmendments"]>[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.contractorAmendments.getContractAmendments(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.contractor_amendments.get_contract_amendments(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.statuses | array | Optional | |
query.statuses[] | string | Each item | One of: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED |
query.sign_statuses | array | Optional | |
query.sign_statuses[] | string | Each item | One of: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED |
query.limit | integer | Optional | Default: 20 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
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 contract amendments — 200 response body |
Referenced models: List contract amendments — 200 response body
Schemas
Section titled “Schemas”List contract amendments — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Required within parent | |
cursor (anyOf 1) | string | Alternative | Cursor for the next page of results. |
cursor (anyOf 2) | null | Alternative | Cursor for the next page of results. |
data | array | Required within parent | List of amendments. IC contracts may return multiple; Global Payroll contracts return at most one (the current pending amendment). |
data[] | Model | Each item | Expand List contract amendments — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more work statements available. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of work statements matching the filters. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List contract amendments — 200 response body — data item
List contract amendments — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand List contract amendments — 200 response body — data / item / sign_status: PENDING, WAITING FOR APPROVAL, APPROVED, DECLINED, status: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED |
$ (anyOf 2) | Model | Alternative | Expand List contract amendments — 200 response body — data item base compensation type, created at, currency code, effective date, id, rate, scale, sign status, status, updated at |
Referenced models: List contract amendments — 200 response body — data / item / sign_status: PENDING, WAITING FOR APPROVAL, APPROVED, DECLINED, status: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED, List contract amendments — 200 response body — data item base compensation type, created at, currency code, effective date, id, rate, scale, sign status, status, updated at
List contract amendments — 200 response body — data / item / sign_status: PENDING, WAITING FOR APPROVAL, APPROVED, DECLINED, status: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_name | JSON | Optional | |
contract_name (anyOf 1) | string | Alternative | Name of the associated contract. |
contract_name (anyOf 2) | null | Alternative | Name of the associated contract. |
contract_type | JSON | Optional | Type of the associated IC contract. |
contract_type (anyOf 1) | string | Alternative | Type of the associated IC contract. Known values: milestones, time_based, ongoing_time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks |
contract_type (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the work statement was created. Format: date-time |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code in ISO 4217 format (e.g., USD, EUR, GBP). Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
currency_code (anyOf 2) | null | Alternative | Currency code in ISO 4217 format (e.g., USD, EUR, GBP). Maximum length: 3 Minimum length: 3 Pattern: ^[A-Z]{3}$ |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Effective date when the work statement becomes active. Format: date-time |
effective_date (anyOf 2) | null | Alternative | Effective date when the work statement becomes active. Format: date-time |
id | string | Required within parent | Unique identifier for the work statement. Format: uuid |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Compensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month). Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Compensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month). Format: double |
scale | JSON | Optional | Payment frequency/scale that defines how often the rate is paid. |
scale (anyOf 1) | string | Alternative | Payment frequency/scale that defines how often the rate is paid. Known values: hourly, daily, weekly, monthly, biweekly, semimonthly, custom |
scale (anyOf 2) | null | Alternative | |
sign_status | string | Required within parent | Current sign status of the work statement. Known values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED |
status | string | Required within parent | Current status of the work statement. Known values: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED |
updated_at | string | Required within parent | Timestamp when the work statement was last updated. Format: date-time |
List contract amendments — 200 response body — data item base compensation type, created at, currency code, effective date, id, rate, scale, sign status, status, updated at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
base_compensation_type | JSON | Optional | Type of base compensation for the amendment. |
base_compensation_type (anyOf 1) | string | Alternative | Type of base compensation for the amendment. Known values: salaried, hourly, unpaid, commission_only |
base_compensation_type (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | Timestamp when the amendment was created. Format: date-time |
currency_code | JSON | Optional | |
currency_code (anyOf 1) | string | Alternative | Currency code for the base compensation. |
currency_code (anyOf 2) | null | Alternative | Currency code for the base compensation. |
effective_date | JSON | Optional | |
effective_date (anyOf 1) | string | Alternative | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Format: date |
effective_date (anyOf 2) | null | Alternative | Short date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect. Format: date |
id | string | Required within parent | Unique identifier for the amendment. Format: uuid |
rate | JSON | Optional | |
rate (anyOf 1) | JSON | Alternative | |
rate (anyOf 1) (anyOf 1) | number | Alternative | Base compensation rate for the amendment. Format: double |
rate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rate (anyOf 2) | null | Alternative | Base compensation rate for the amendment. Format: double |
scale | JSON | Optional | Payment scale for the base compensation. |
scale (anyOf 1) | string | Alternative | Payment scale for the base compensation. Known values: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off |
scale (anyOf 2) | null | Alternative | |
sign_status | JSON | Required within parent | Sign status is not tracked for Global Payroll amendments; always null. Signing state is conveyed by `status`. Filters `statuses` and `sign_statuses` apply to Individual Contractor contracts only and are ignored for Global Payroll contracts. |
sign_status (anyOf 1) | string | Alternative | Sign status is not tracked for Global Payroll amendments; always null. Signing state is conveyed by `status`. Filters `statuses` and `sign_statuses` apply to Individual Contractor contracts only and are ignored for Global Payroll contracts. Known values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED |
sign_status (anyOf 2) | null | Alternative | |
status | string | Required within parent | Status of the Global Payroll amendment. Known values: waiting_for_approval, waiting_client_sign, waiting_worker_sign, signed, completed, obsolete |
updated_at | string | Required within parent | Timestamp when the amendment was last updated. Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.contractoramendments_getcontractamendments. Catalog operation: contractoramendments_getcontractamendments. 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"}