### Successful Profile Setup Response Source: https://developer.deel.com/api/reference/endpoints/workers/complete-individual-contractor-profile-setup-v-2026-01-01 This is an example of a successful response when an individual contractor's profile setup is completed. ```json { "data": { "profile_id": 2033569, "company_type": "individual", "abn": "12345678901", "ssn": "123456789", "zip": "10001", "city": "New York", "phone": "+15551234567", "street": "101 Main St", "citizen": "US", "country": "US", "id_type": "passport", "province": "NY", "timezone": "America/New_York", "personal_id": "AB1234567", "legal_status": "individual", "tax_residence": "US", "onboarding_step": "PROFILE_COMPLETED", "entity_tax_residence": "US" } } ``` -------------------------------- ### Example API Request for Contracts Source: https://developer.deel.com/api/reference/endpoints/adjustments/get-contract-adjustments This cURL example demonstrates how to make a GET request to retrieve a list of contracts, including the necessary Authorization header. ```bash curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` -------------------------------- ### Example API Response Source: https://developer.deel.com/api/reference/endpoints/knowledge-hub/get-knowledge-hub-country-guides-by-country-code This is an example of a successful JSON response when retrieving country guides. It includes data on audiences, contract types, and pagination information. ```json { "data": [ { "name": "Contractor", "value": "contractor" } ], "has_more": false, "next_cursor": "abcdef01-2345-6789-0abc-def012345678", "total_count": 2 } ``` -------------------------------- ### Example API Call for Authentication Source: https://developer.deel.com/api/reference/endpoints/custom-fields-contracts/put-contract-custom-field This example demonstrates how to make a GET request to the /v2/contracts endpoint, including the necessary Authorization header for authentication. Replace YOUR-TOKEN-HERE with your actual API token. ```cURL $ curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` -------------------------------- ### Example Response for Hiring Guide Source: https://developer.deel.com/api/embedded/eor-endpoints/eor-hiring/get-eor-hiring-guide-by-country This JSON object shows the structure of the data returned when retrieving a country's hiring guide, including salary, holiday, probation, and health insurance details. ```JSON 1| { 2| "data": { 3| "salary": { 4| "max": "10000", 5| "min": "2000", 6| "frequency": "monthly" 7| }, 8| "holiday": { 9| "max": "25", 10| "min": "15", 11| "mostCommon": "20" 12| }, 13| "currency": "USD", 14| "probation": { 15| "max": 3, 16| "min": 1 17| }, 18| "health_insurance": { 19| "status": "ENABLED", 20| "providers": [ 21| { 22| "id": "123e4567-e89b-12d3-a456-426614174000", 23| "name": "HealthCare Plus" 24| } 25| ] 26| } 27| } 28| } ``` -------------------------------- ### Example Response for Onboarding Details Source: https://developer.deel.com/api/stable/reference/endpoints/onboarding/get-onboarding-details-by-onboarding-tracker-id-v-2026-01-01 This is an example of the JSON response you can expect when successfully retrieving onboarding details. It includes profile information, stepper progress, summary, contract details, and checklist status. ```json 1| { 2| "data": { 3| "profile": { 4| "name": "John Doo", 5| "email": "test@email.com", 6| "country": "CA", 7| "last_login": "2021-07-14T22:00:00+00:00", 8| "previously_onboarded": true 9| }, 10| "stepper": [ 11| { 12| "data": { 13| "emails": [ 14| { 15| "meta": { 16| "type": "CONTRACTOR_INVITE_SIGN_UP", 17| "email": "test@email.com", 18| "sent_at": "2021-07-14T22:00:00+00:00" 19| } 20| } 21| ], 22| "next_reminder_date": "2021-07-14T22:00:00+00:00" 23| }, 24| "type": "REMINDER_SENT", 25| "completed_at": "2021-07-14T22:00:00+00:00" 26| } 27| ], 28| "summary": [ 29| { 30| "data": { 31| "country": "CA", 32| "timezone": "Europe/Brussels", 33| "has_withdraw_methods": true 34| }, 35| "name": "Contract start date", 36| "type": "START_DATE", 37| "value": "2021-07-14T22:00:00+00:00" 38| } 39| ], 40| "contract": { 41| "id": "PzpYaren", 42| "oid": "PzpYaren", 43| "name": "Contract Name", 44| "status": "in_progress", 45| "created_at": "2021-07-14T22:00:00+00:00", 46| "first_sign": "client", 47| "completion_date": "2021-07-14T22:00:00+00:00", 48| "client_signed_at": "2021-07-14T22:00:00+00:00", 49| "employee_agreement": { 50| "status": "AwaitingEmployeeSignature", 51| "version_hash": "cdf4f572eb13a5eaf46d" 52| }, 53| "first_early_invoice": { 54| "id": "9r259RyjAnP7GeMpQnjAT", 55| "amount": "100.00", 56| "status": "PENDING", 57| "paid_at": "2026-03-01T00:00:00+00:00", 58| "currency": "EUR", 59| "due_date": "2026-04-01T00:00:00.000Z", 60| "description": "EOR funding statement for February, 2026" 61| }, 62| "contractor_signed_at": "2021-07-14T22:00:00+00:00", 63| "invited_contractor_email": "test@email.com" 64| }, 65| "progress": { 66| "status": "ACTIVE", 67| "reference_date": "2021-07-14T22:00:00+00:00", 68| "subject_to_overdue": true, 69| "reference_date_timezone": "Europe/Brussels", 70| "is_action_required_from_client": true 71| }, 72| "checklist": { 73| "steps": [ 74| { 75| "type": "sign_up_to_deel", 76| "label": "Create contractor account", 77| "status": "done", 78| "completed_at": "2021-07-14T22:00:00+00:00", 79| "reject_reason": "

Please submit the correct document for Form 145

" 80| } 81| ] 82| }, 83| "hiring_type": "contractor", 84| "hris_profile": { 85| "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698", 86| "name": "John Doo", 87| "email": "test@email.com", 88| "work_email": "test@email.com" 89| } 90| } 91| } ``` -------------------------------- ### cURL Request to Get EOR Worker Bank Guide Source: https://developer.deel.com/api/embedded/eor-worker-endpoints/worker-banks/get-eor-worker-bank-guide-by-country-and-currency Use this cURL command to make a GET request to the API endpoint. Replace `` with your actual authorization token. This example specifies France (FR) and Euro (EUR) as the country and currency. ```bash $ curl https://api.letsdeel.com/rest/eor/workers/banks-guide/country/FR/currency/EUR \ -H "Authorization: Bearer " ``` -------------------------------- ### Example JSON Response for Onboarding Details Source: https://developer.deel.com/api/reference/endpoints/onboarding/get-onboarding-details-by-onboarding-tracker-id-v-2026-01-01 This is a sample JSON response detailing a worker's onboarding status, including profile, stepper, summary, contract, progress, checklist, and HRIS information. ```json { "data": { "profile": { "name": "John Doo", "email": "test@email.com", "country": "CA", "last_login": "2021-07-14T22:00:00+00:00", "previously_onboarded": true }, "stepper": [ { "data": { "emails": [ { "meta": { "type": "CONTRACTOR_INVITE_SIGN_UP", "email": "test@email.com", "sent_at": "2021-07-14T22:00:00+00:00" } } ], "next_reminder_date": "2021-07-14T22:00:00+00:00" }, "type": "REMINDER_SENT", "completed_at": "2021-07-14T22:00:00+00:00" } ], "summary": [ { "data": { "country": "CA", "timezone": "Europe/Brussels", "has_withdraw_methods": true }, "name": "Contract start date", "type": "START_DATE", "value": "2021-07-14T22:00:00+00:00" } ], "contract": { "id": "PzpYaren", "oid": "PzpYaren", "name": "Contract Name", "status": "in_progress", "created_at": "2021-07-14T22:00:00+00:00", "first_sign": "client", "completion_date": "2021-07-14T22:00:00+00:00", "client_signed_at": "2021-07-14T22:00:00+00:00", "employee_agreement": { "status": "AwaitingEmployeeSignature", "version_hash": "cdf4f572eb13a5eaf46d" }, "first_early_invoice": { "id": "9r259RyjAnP7GeMpQnjAT", "amount": "100.00", "status": "PENDING", "paid_at": "2026-03-01T00:00:00+00:00", "currency": "EUR", "due_date": "2026-04-01T00:00:00.000Z", "description": "EOR funding statement for February, 2026" }, "contractor_signed_at": "2021-07-14T22:00:00+00:00", "invited_contractor_email": "test@email.com" }, "progress": { "status": "ACTIVE", "reference_date": "2021-07-14T22:00:00+00:00", "subject_to_overdue": true, "reference_date_timezone": "Europe/Brussels", "is_action_required_from_client": true }, "checklist": { "steps": [ { "type": "sign_up_to_deel", "label": "Create contractor account", "status": "done", "completed_at": "2021-07-14T22:00:00+00:00", "reject_reason": "

Please submit the correct document for Form 145

" } ] }, "hiring_type": "contractor", "hris_profile": { "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698", "name": "John Doo", "email": "test@email.com", "work_email": "test@email.com" } } } ``` -------------------------------- ### Example Response for EOR Hiring Guide Source: https://developer.deel.com/api/stable/reference/endpoints/eor-hiring/get-eor-hiring-guide-by-country This is an example of the JSON response you will receive when successfully retrieving EOR hiring guide data for a specific country. It contains detailed information on salary, holidays, probation, and health insurance. ```JSON 1| { ---|--- 2| "data": { 3| "salary": { 4| "max": "10000", 5| "min": "2000", 6| "frequency": "monthly" 7| }, 8| "holiday": { 9| "max": "25", 10| "min": "15", 11| "mostCommon": "20" 12| }, 13| "currency": "USD", 14| "probation": { 15| "max": 3, 16| "min": 1 17| }, 18| "health_insurance": { 19| "status": "ENABLED", 20| "providers": [ 21| { 22| "id": "123e4567-e89b-12d3-a456-426614174000", 23| "name": "HealthCare Plus" 24| } 25| ] 26| } 27| } 28| } ``` -------------------------------- ### Basic Authentication Example Source: https://developer.deel.com/api/reference/endpoints/contracts/get-contracts This example demonstrates how to authenticate with the Deel API using a bearer token. Replace 'YOUR-TOKEN-HERE' with your actual token. ```bash curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` -------------------------------- ### EOR Start Date Response Source: https://developer.deel.com/api/eor-endpoints/eor-hiring/get-start-date This is an example of a successful response when retrieving the EOR contract start date. It includes the minimum start date and payroll timing details. ```json 1| { ---|--- 2| "data": { 3| "min_start_date": "2025-05-19T21:09:54.630Z", 4| "start_date_buffer": 1, 5| "first_payroll_lock": 20, 6| "is_same_month_payment_country": false 7| } 8| } ``` -------------------------------- ### API Authentication Example Source: https://developer.deel.com/api/reference/endpoints/worker-relations/get-worker-relation-types Example of how to authenticate API requests using a bearer token with the `X-Version` header for date versioning. ```bash $| curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` -------------------------------- ### Example JSON Response for Onboarding Details Source: https://developer.deel.com/api/reference/endpoints/onboarding/get-onboarding-details-by-employee-hris-profile-id-v-2026-01-01 This is an example of the JSON response you can expect when successfully retrieving onboarding details. It contains comprehensive information about the employee's profile, onboarding progress, contract, and checklist status. ```json 1| { ---|--- 2| "data": { 3| "profile": { 4| "name": "John Doo", 5| "email": "test@email.com", 6| "country": "CA", 7| "last_login": "2021-07-14T22:00:00+00:00", 8| "previously_onboarded": true 9| }, 10| "stepper": [ 11| { 12| "data": { 13| "emails": [ 14| { 15| "meta": { 16| "type": "CONTRACTOR_INVITE_SIGN_UP", 17| "email": "test@email.com", 18| "sent_at": "2021-07-14T22:00:00+00:00" 19| } 20| } 21| ], 22| "next_reminder_date": "2021-07-14T22:00:00+00:00" 23| }, 24| "type": "REMINDER_SENT", 25| "completed_at": "2021-07-14T22:00:00+00:00" 26| } 27| ], 28| "summary": [ 29| { 30| "data": { 31| "country": "CA", 32| "timezone": "Europe/Brussels", 33| "has_withdraw_methods": true 34| }, 35| "name": "Contract start date", 36| "type": "START_DATE", 37| "value": "2021-07-14T22:00:00+00:00" 38| } 39| ], 40| "contract": { 41| "id": "PzpYaren", 42| "oid": "PzpYaren", 43| "name": "Contract Name", 44| "status": "in_progress", 45| "created_at": "2021-07-14T22:00:00+00:00", 46| "first_sign": "client", 47| "completion_date": "2021-07-14T22:00:00+00:00", 48| "client_signed_at": "2021-07-14T22:00:00+00:00", 49| "employee_agreement": { 50| "status": "AwaitingEmployeeSignature", 51| "version_hash": "cdf4f572eb13a5eaf46d" 52| }, 53| "first_early_invoice": { 54| "id": "9r259RyjAnP7GeMpQnjAT", 55| "amount": "100.00", 56| "status": "PENDING", 57| "paid_at": "2026-03-01T00:00:00+00:00", 58| "currency": "EUR", 59| "due_date": "2026-04-01T00:00:00.000Z", 60| "description": "EOR funding statement for February, 2026" 61| }, 62| "contractor_signed_at": "2021-07-14T22:00:00+00:00", 63| "invited_contractor_email": "test@email.com" 64| }, 65| "progress": { 66| "status": "ACTIVE", 67| "reference_date": "2021-07-14T22:00:00+00:00", 68| "subject_to_overdue": true, 69| "reference_date_timezone": "Europe/Brussels", 70| "is_action_required_from_client": true 71| }, 72| "checklist": { 73| "steps": [ 74| { 75| "type": "sign_up_to_deel", 76| "label": "Create contractor account", 77| "status": "done", 78| "completed_at": "2021-07-14T22:00:00+00:00", 79| "reject_reason": "

Please submit the correct document for Form 145

" 80| } 81| ] 82| }, 83| "hiring_type": "contractor", 84| "hris_profile": { 85| "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698", 86| "name": "John Doo", 87| "email": "test@email.com", 88| "work_email": "test@email.com" 89| } 90| } 91| } ``` -------------------------------- ### Example Response Structure Source: https://developer.deel.com/api/embedded/eor-worker-endpoints/worker-banks/get-eor-worker-bank-guide This is an example of the JSON response you will receive when retrieving the bank account form guide. It outlines the fields, their types, and validation rules. ```json { "data": [ { "key": "countryCode", "required": true, "type": "text", "label": "Country", "validations": [ { "type": "MIN_LENGTH", "value": "2" } ], "values_allowed": [ { "label": "Argentina", "value": "AR" } ] } ] } ``` -------------------------------- ### Example Response for Onboarding Case Source: https://developer.deel.com/api/stable/endpoints/immigration/get-worker-onboarding-case This is an example of a successful response when retrieving a worker's onboarding case. It includes details about the case status, process, associated contract, applicant, documents, and timestamps. ```json 1| { 2| "data": { 3| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 4| "status": "OPEN", 5| "process": { 6| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 7| "name": "WORK_AUTHORIZATION_VERIFICATION", 8| "status": "IN_REVIEW", 9| "rejection_note": "We couldn't accept the document because the file or photo that has been submitted cannot be read fully.", 10| "rejection_reason": "Poor image quality" 11| }, 12| "contract": { 13| "id": "359pr8y" 14| }, 15| "applicant": { 16| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 17| "external_id": "123456" 18| }, 19| "case_type": "IMMIGRATION_DOCUMENT_REVIEW", 20| "documents": [ 21| { 22| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 23| "status": "EXPIRING", 24| "document_type": "Eu blue card", 25| "expiration_date": "2023-10-31T13:45:30Z" 26| } 27| ], 28| "visa_type": "Eu blue card", 29| "created_at": "2023-10-31T13:45:30Z", 30| "updated_at": "2023-10-31T13:45:30Z", 31| "country_code": "DE", 32| "estimated_completion_date": "2023-10-31T13:45:30Z" 33| } 34| } ``` -------------------------------- ### Example Response for Onboarding Case Source: https://developer.deel.com/api/stable/reference/endpoints/immigration/get-worker-onboarding-case This is an example of a successful response when retrieving a worker's onboarding case. It includes details about the case status, process, associated contract, applicant, and any submitted documents with their statuses and expiration dates. ```json 1| { ---|--- 2| "data": { 3| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 4| "status": "OPEN", 5| "process": { 6| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 7| "name": "WORK_AUTHORIZATION_VERIFICATION", 8| "status": "IN_REVIEW", 9| "rejection_note": "We couldn't accept the document because the file or photo that has been submitted cannot be read fully.", 10| "rejection_reason": "Poor image quality" 11| }, 12| "contract": { 13| "id": "359pr8y" 14| }, 15| "applicant": { 16| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 17| "external_id": "123456" 18| }, 19| "case_type": "IMMIGRATION_DOCUMENT_REVIEW", 20| "documents": [ 21| { 22| "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", 23| "status": "EXPIRING", 24| "document_type": "Eu blue card", 25| "expiration_date": "2023-10-31T13:45:30Z" 26| } 27| ], 28| "visa_type": "Eu blue card", 29| "created_at": "2023-10-31T13:45:30Z", 30| "updated_at": "2023-10-31T13:45:30Z", 31| "country_code": "DE", 32| "estimated_completion_date": "2023-10-31T13:45:30Z" 33| } 34| } ``` -------------------------------- ### Example Response for Fetch All Payout Methods Source: https://developer.deel.com/api/reference/endpoints/payouts/fetch-all-payout-methods-v-2026-01-01 This is an example of a successful response when retrieving payout methods. It includes details like address, payment payload, and the payment method type. ```json 1| { 2| "data": { 3| "address": { 4| "city": "San Francisco", 5| "country": "US", 6| "post_code": "210000", 7| "first_line": "First Line" 8| }, 9| "payload": { 10| "currency": "US", 11| "swiftCode": "DBDBRSBG", 12| "intermediary": { 13| "bic": "RSDASDS", 14| "country": "DE" 15| }, 16| "accountNumber": "SA0380000000608010167222", 17| "accountHolderName": "John Doe" 18| }, 19| "payment_method": "bank_transfer" 20| } 21| } ``` -------------------------------- ### Example Response for Get Worker Invite Link Source: https://developer.deel.com/api/embedded/ic-endpoints/contractor-hiring/get-contract-invite This is an example of a successful response when retrieving a worker invite link. The response contains the invitation URL. ```json 1| { ---|--- 2| "data": "https://app.letsdeel.com/invite/worker/37nex2x?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9" 3| } ``` -------------------------------- ### Get Country Guides by Country Code Source: https://developer.deel.com/api/stable/reference/endpoints/knowledge-hub/get-knowledge-hub-country-guides-by-country-code Use this cURL command to retrieve country guides for a specific country code. Ensure you include your authorization token. ```curl $| curl https://api.letsdeel.com/rest/knowledge-hub/country-guide/AL \ ---|--- >| -H "Authorization: Bearer " ``` -------------------------------- ### Get Knowledge Hub Country Guides by Country Code Source: https://developer.deel.com/api/reference/endpoints/knowledge-hub/get-knowledge-hub-country-guides-by-country-code Fetches country guides for a given country code. Requires `knowledge-hub:read` token scope. ```APIDOC ## GET /rest/knowledge-hub/country-guide/:country_code ### Description Returns country guides segmented by audience and contract type for the specified `country_code`. ### Method GET ### Endpoint /rest/knowledge-hub/country-guide/:country_code ### Parameters #### Path Parameters - **country_code** (string) - Required - Country code for which we need to fetch the country guides #### Request Example ```bash curl https://api.letsdeel.com/rest/knowledge-hub/country-guide/AL \ -H "Authorization: Bearer " ``` ### Response #### Success Response (200) - **data** (list of objects) - List of different audiences with associated categories and contract types. - **name** (string) - **value** (string) - **has_more** (boolean) - Indicates if there are more items to fetch. - **next_cursor** (string or null) - Cursor for the next page of results - **total_count** (double) - Total number of audiences #### Response Example ```json { "data": [ { "name": "Contractor", "value": "contractor" } ], "has_more": false, "next_cursor": "abcdef01-2345-6789-0abc-def012345678", "total_count": 2 } ``` ### Errors - **400** - Bad Request Error - **401** - Unauthorized Error - **403** - Forbidden Error - **404** - Not Found Error - **500** - Internal Server Error ``` -------------------------------- ### Example Amendment Validation Settings Response Source: https://developer.deel.com/api/employer-of-record/amendments An example response from the Get Amendment validation settings endpoint, detailing rules for data points like `notice_period_type` based on `employment_type`. ```json 1| [ 2| { 3| "data_point": "notice_period_type", 4| "rules": [ 5| { 6| "nullable": false, 7| "is_editable": true, 8| "possible_options": ["STANDARD", "CUSTOM"], 9| "requires": { 10| "employment_type": "FULL_TIME" 11| } 12| }, 13| { 14| "nullable": false, 15| "is_editable": true, 16| "possible_options": ["STANDARD", "CUSTOM"], 17| "requires": { 18| "employment_type": "PART_TIME" 19| } 20| } 21| ] 22| } 23| ] ``` -------------------------------- ### Bank Guide Response Structure Source: https://developer.deel.com/api/stable/reference/endpoints/worker-information/get-gp-worker-bank-guide This is an example of the JSON response when successfully retrieving the bank guide. It details the fields, their requirements, and allowed values for a worker's bank account form. ```json 1| { ---|--- 2| "data": [ 3| { 4| "key": "countryCode", 5| "required": true, 6| "type": "Text", 7| "label": "Country", 8| "validations": [ 9| { 10| "type": "MIN_LENGTH", 11| "value": "2" 12| } 13| ], 14| "values_allowed": [ 15| { 16| "label": "Argentina", 17| "value": "AR" 18| } 19| ] 20| } 21| ] 22| } ``` -------------------------------- ### Node.js Example with Axios Source: https://developer.deel.com/api/authentication This Node.js example demonstrates how to use the Axios library to make authenticated requests to the Deel API by setting the `Authorization` header. ```APIDOC ## Node.js Example ```javascript const axios = require('axios'); const deelAPI = axios.create({ baseURL: 'https://api.letsdeel.com/rest', headers: { 'Authorization': `Bearer ${process.env.DEEL_API_TOKEN}` } }); // Make authenticated request const response = await deelAPI.get('/contracts'); ``` ``` -------------------------------- ### Create IC Contract Request Source: https://developer.deel.com/api/stable/endpoints/contracts/create-ic-contract This example demonstrates how to make a POST request to create an IC contract. Ensure you include the necessary contract details and authentication headers. ```bash $ curl -X POST \"https://api.letsdeel.com/rest/v2/contracts\" \ -H \"Authorization: Bearer YOUR-TOKEN-HERE\" \ -H \"Content-Type: application/json\" \ -d @create-ic-contract-request.json ``` -------------------------------- ### Get amendments by contract Source: https://developer.deel.com/api/embedded/eor-endpoints/eor-amendments/get-contract-amendments This example shows how to retrieve amendments for a specific contract using its ID. ```APIDOC ## GET /rest/eor/contracts/:contract_id/amendments ### Description Retrieves a list of all amendments for a specified contract. ### Method GET ### Endpoint /rest/eor/contracts/:contract_id/amendments ### Parameters #### Path Parameters - **contract_id** (string) - Required - The unique identifier of the contract. ### Request Example ```bash curl -X GET https://api.letsdeel.com/rest/eor/contracts/3w6pd6r/amendments \ -H "Authorization: Bearer " ``` ### Response #### Success Response (200) (Response structure not provided in source text) ``` -------------------------------- ### Example HTML Response Source: https://developer.deel.com/api/stable/embedded/ic-endpoints/contractor-hiring/get-contract-preview This is an example of the HTML content returned when successfully previewing a contract agreement. ```html 1| "Contract Preview

Independent Contractor Agreement

This agreement is made between Acme Corp and John Doe, effective April 15, 2024.

Terms and Conditions

  • Contractor shall provide software development services.
  • Payment terms: $75/hour, invoiced monthly.
  • Contract duration: 6 months.

By signing below, both parties agree to the terms stated herein.

Signature: ____________________

" ``` -------------------------------- ### Example Response for Get Immigration Case Details Source: https://developer.deel.com/api/endpoints/immigration/get-client-case This is an example of a successful JSON response when retrieving immigration case details. It includes information about the case status, process, applicant, documents, and dates. ```json { "data": { "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", "status": "OPEN", "process": { "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", "name": "Document check", "status": "In Review" }, "applicant": { "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", "external_id": "123456" }, "case_type": "Right to Work", "documents": [ { "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", "status": "IN_REVIEW", "document_type": "Eu blue card", "expiration_date": "2023-10-31T13:45:30Z" } ], "visa_type": "Eu blue card", "country_code": "DE", "last_update_at": "2023-10-31T13:45:30Z", "case_created_at": "2023-10-31T13:45:30Z", "estimated_completion_date": "2023-10-31T13:45:30Z" } } ``` -------------------------------- ### Retrieve ATS Applications List Source: https://developer.deel.com/api/reference/endpoints/ats-applications/retrieve-a-list-of-ats-applications-v-2026-01-01 This example demonstrates how to fetch a list of ATS applications. Ensure you have the 'ats:read' scope for authentication. The response includes application details, pagination information, and total count. ```json { "data": [ { "id": "f6281620-93be-45fb-ab91-dd1d8cd89395", "created_at": "2025-06-18T13:04:03.920Z", "numeric_id": 183, "moved_to_current_stage_at": "2025-06-18T13:04:04.805Z", "job": { "id": "45039abb-82a7-49c8-80f7-dbb0946c5fd4", "title": "Senior Product Designer" }, "candidate": { "id": "7b6b3d8e-84b7-4bbe-a680-faf2bec43dca", "email": "john.doe@example.com", "pic_url": "https://example.com/avatars/john-doe.jpg", "last_name": "Doe", "first_name": "John", "phone_number": "+1234567890", "candidate_tags": [ { "id": "0d84657e-2fce-4f67-8cb1-9d88cf1ff994", "tag": { "id": "c8a7d362-6960-4f75-98d3-5118df39c84c", "label": "Top talent" } }, { "id": "d5a42e62-6872-46bf-906c-4df01b51eaf0", "tag": { "id": "06ace055-faf4-4436-a148-76e58ee95d13", "label": "Technical expert" } } ] }, "job_posting": { "id": "c3d4e5f6-a7b8-9012-3456-7890abcdef12", "title": "Senior Product Designer - Remote" }, "source_slug": "INTERNAL_CAREER_PAGE", "job_employment_type": { "id": "98ee37f0-9dd1-4d0f-82d9-1008e7cc92e6", "employment_type": { "id": "e34044e5-412c-4033-b940-8d0956d5943b", "name": "Full-time" } }, "submitter_ip_address": "203.0.113.42", "submitter_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36", "application_form_submission": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "answers": [ { "answer": "John Doe", "question_text": "Full Name", "question_type": "FREETEXT", "data_binding_id": "83a642fd-de0a-45f6-8fe0-b9188ed72990" } ] }, "application_job_criterias_matchings": [ { "id": "a7b8c9d0-e1f2-3456-789a-bcdef1234567", "is_matched": "MATCHED", "description": "5+ years of experience with design systems", "job_criteria_id": "b8c9d0e1-f2a3-4567-89ab-cdef12345678" }, { "id": "b8c9d0e1-f2a3-4567-89ab-cdef12345679", "is_matched": "MATCHED", "description": "Experience with Figma and prototyping tools", "job_criteria_id": "c9d0e1f2-a3b4-5678-9abc-def123456789" }, { "id": "c9d0e1f2-a3b4-5678-9abc-def12345678a", "is_matched": "UNDECIDED", "description": "Portfolio demonstrating UX research skills", "job_criteria_id": "d0e1f2a3-b4c5-6789-abcd-ef123456789a" } ], "created_by_hris_organization_user_id": "b2ab2c64-9443-455a-af6e-eed9f3426b26", "current_application_interview_plan_stage": { "id": "cc7ec13b-c0c7-46d7-b9a2-e7f60503a8a2", "application_id": "f6281620-93be-45fb-ab91-dd1d8cd89395", "interview_plan_stage": { "id": "5c1d7a1b-d1db-4987-a406-9f87d57a4f04", "name": "Technical Interview", "default_type_slug": "technical_interview", "category_type_slug": "active" }, "interview_plan_stage_id": "5c1d7a1b-d1db-4987-a406-9f87d57a4f04" }, "current_application_interview_plan_stage_id": "cc7ec13b-c0c7-46d7-b9a2-e7f60503a8a2", "application_form_form_builder_form_submission_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ], "has_more": true, "next_cursor": "eyJsYXN0Q3JlYXRlZEF0IjoiMjAyNS0wNi0xOFQxMzowNDozLjkxMFoiLCJsYXN0SWQiOiJmNjI4MTYyMC05M2JlLTRmZmItYWI5MS1kZDFkOGNkODkzOTUifQ==", "total_count": 150 } ``` -------------------------------- ### Example Response for Service Provider Config Source: https://developer.deel.com/api/reference/endpoints/service-provider-config/get-service-provider-config This is an example of the JSON response received when successfully retrieving the service provider configuration. It details supported API features. ```json { "authenticationSchemes": { "authenticationSchemes": [ { "description": "OAuth 2.0 Bearer Token authentication", "documentationUrl": "https://developer.deel.com/docs/authentication", "name": "OAuth Bearer Token", "specUrl": "https://tools.ietf.org/html/rfc6750" } ] }, "bulk": { "maxOperations": 1000, "maxPayloadSize": 1048576, "supported": true }, "changePassword": { "supported": true }, "etag": { "supported": true }, "filter": { "maxResults": 200, "supported": true }, "patch": { "supported": true }, "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig" ], "sort": { "supported": true }, "xmlDataFormat": { "supported": false } } ``` -------------------------------- ### Get Contracts Source: https://developer.deel.com/api/endpoints/contractor-hiring/get-contract-invitations Example of how to authenticate an API call to retrieve a list of contracts using a bearer token. ```cURL $| curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ ---|--- >| -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` -------------------------------- ### Example API Response (201 Created) Source: https://developer.deel.com/api/stable/reference/endpoints/immigration/create-worker-case-required-document This is an example of a successful response when a document is uploaded and submitted for review. ```json { "data": { "id": "5f5b3b3b-4b3b-4b3b-4b3b-4b3b3b3b3b3b", "status": "IN_REVIEW", "created_at": "2023-10-31T13:45:30Z", "updated_at": "2023-10-31T13:45:30Z" } } ``` -------------------------------- ### Retrieve EOR Worker Bank Guide Source: https://developer.deel.com/api/embedded/eor-worker-endpoints/worker-banks/get-eor-worker-bank-guide Use this endpoint to get the bank account form guide for an EOR employee. It provides the necessary field structure for adding a new bank account. Ensure you have the `worker:read` token scope. ```bash $ curl https://api.letsdeel.com/rest/eor/workers/banks/guide \ -H "Authorization: Bearer " ``` -------------------------------- ### EOR Hiring Guide Response Structure Source: https://developer.deel.com/api/eor-endpoints/eor-hiring/get-eor-hiring-guide-by-country Example JSON response detailing salary, holiday, probation, and health insurance information for a country. ```json { "data": { "salary": { "max": "10000", "min": "2000", "frequency": "monthly" }, "holiday": { "max": "25", "min": "15", "mostCommon": "20" }, "currency": "USD", "probation": { "max": 3, "min": 1 }, "health_insurance": { "status": "ENABLED", "providers": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "HealthCare Plus" } ] } } } ```