Skip to content

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.

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 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.contractor_amendments.get_contract_amendments(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.statusesarrayOptional
query.statuses[]stringEach itemOne of: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
query.sign_statusesarrayOptional
query.sign_statuses[]stringEach itemOne of: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.cursorstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List contract amendments — 200 response body

Referenced models: List contract amendments — 200 response body

List contract amendments — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONRequired within parent
cursor (anyOf 1)stringAlternativeCursor for the next page of results.
cursor (anyOf 2)nullAlternativeCursor for the next page of results.
dataarrayRequired within parentList of amendments. IC contracts may return multiple; Global Payroll contracts return at most one (the current pending amendment).
data[]ModelEach itemExpand List contract amendments — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more work statements available.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of work statements matching the filters.
total_count (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand 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)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
contract_nameJSONOptional
contract_name (anyOf 1)stringAlternativeName of the associated contract.
contract_name (anyOf 2)nullAlternativeName of the associated contract.
contract_typeJSONOptionalType of the associated IC contract.
contract_type (anyOf 1)stringAlternativeType 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)nullAlternative
created_atstringRequired within parentTimestamp when the work statement was created.
Format: date-time
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code in ISO 4217 format (e.g., USD, EUR, GBP).
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeCurrency code in ISO 4217 format (e.g., USD, EUR, GBP).
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeEffective date when the work statement becomes active.
Format: date-time
effective_date (anyOf 2)nullAlternativeEffective date when the work statement becomes active.
Format: date-time
idstringRequired within parentUnique identifier for the work statement.
Format: uuid
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeCompensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month).
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeCompensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month).
Format: double
scaleJSONOptionalPayment frequency/scale that defines how often the rate is paid.
scale (anyOf 1)stringAlternativePayment frequency/scale that defines how often the rate is paid.
Known values: hourly, daily, weekly, monthly, biweekly, semimonthly, custom
scale (anyOf 2)nullAlternative
sign_statusstringRequired within parentCurrent sign status of the work statement.
Known values: PENDING, WAITING_FOR_APPROVAL, APPROVED, DECLINED
statusstringRequired within parentCurrent status of the work statement.
Known values: INITIAL, PENDING, ACTIVE, OUTDATED, APPROVED, DECLINED
updated_atstringRequired within parentTimestamp 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
FieldTypePresenceDescription and constraints
$objectRoot
base_compensation_typeJSONOptionalType of base compensation for the amendment.
base_compensation_type (anyOf 1)stringAlternativeType of base compensation for the amendment.
Known values: salaried, hourly, unpaid, commission_only
base_compensation_type (anyOf 2)nullAlternative
created_atstringRequired within parentTimestamp when the amendment was created.
Format: date-time
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code for the base compensation.
currency_code (anyOf 2)nullAlternativeCurrency code for the base compensation.
effective_dateJSONOptional
effective_date (anyOf 1)stringAlternativeShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.
Format: date
effective_date (anyOf 2)nullAlternativeShort date in format ISO-8601 (YYYY-MM-DD) when the amendment takes effect.
Format: date
idstringRequired within parentUnique identifier for the amendment.
Format: uuid
rateJSONOptional
rate (anyOf 1)JSONAlternative
rate (anyOf 1) (anyOf 1)numberAlternativeBase compensation rate for the amendment.
Format: double
rate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rate (anyOf 2)nullAlternativeBase compensation rate for the amendment.
Format: double
scaleJSONOptionalPayment scale for the base compensation.
scale (anyOf 1)stringAlternativePayment scale for the base compensation.
Known values: hourly, daily, weekly, monthly, annually, two_weekly, bi_monthly, custom, one_off
scale (anyOf 2)nullAlternative
sign_statusJSONRequired within parentSign 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)stringAlternativeSign 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)nullAlternative
statusstringRequired within parentStatus of the Global Payroll amendment.
Known values: waiting_for_approval, waiting_client_sign, waiting_worker_sign, signed, completed, obsolete
updated_atstringRequired within parentTimestamp when the amendment was last updated.
Format: date-time

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

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.