> This page is for API, version 2026-01-01 (Stable) (default). > For other versions, use one of these documentation indexes: > - 2026-01-01 (Stable) (default): https://developer.deel.com/api/stable/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.deel.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server. # Retrieve offboarding list GET https://api.letsdeel.com/rest/offboarding/tracker Returns a list of contracts currently in the offboarding process. By default, results are scoped to a 45-day date range; set `ignore_date_range` to `true` to retrieve all terminations regardless of date. **Token scopes**: `contracts:read`, `people:read` Reference: https://developer.deel.com/api/reference/endpoints/offboarding/retrieve-offboarding-list-v-2026-01-01 ## Authentication - `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication) - `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/ ## Servers - `https://api.letsdeel.com/rest` (Production, default) - `https://api-staging.letsdeel.com/rest` (Demo) ## Request ### Query parameters - `search` (string, optional) — Search term to filter contracts by name or other attributes - `hiring_types` (list of enum, optional, default: []) — Filter by hiring type. - Allowed values: `contractor`, `eor`, `peo`, `hris_direct_employee`, `direct_employee`, `person_without_contract` - `progress_statuses` (list of enum, optional, default: []) — Filter by offboarding progress status. - Allowed values: `IN_REVIEW`, `DOCUMENT_PROCESSING`, `EMPLOYEE_OFFBOARDING`, `FINAL_PAYMENT_AND_REFUND`, `COMPLETED`, `AWAITING_CLIENT_SIGNATURE`, `AWAITING_CONTRACTOR_SIGNATURE`, `TERMINATION_LETTER_REJECTED`, `CONTRACT_ENDING`, `CONTRACT_ENDED`, `OFFBOARDING`, `INACTIVE`, `AWAITING_TERMINATION_DETAILS` - `limit` (integer, optional, default: 20) — Number of results to return per page (maximum 100; values above this are silently clamped to 100) - `sort_by` (enum, optional, default: progressStatusWeight) — Field to sort by - Allowed values: `progressStatusWeight` - `sort_order` (enum, optional, default: ASC) — Sorting order - Allowed values: `ASC`, `DESC` - `pagination` (OffboardingTrackerGetParametersPagination, optional, deprecated) — Deprecated. Use `cursor` instead. - `cursor` (string, optional) — Opaque pagination cursor from the previous response's `page.cursor`. Pass it back verbatim to fetch the next page; omit it for the first page. - `include_overview` (boolean, optional, default: false) — Include an overview of the contract - `ignore_date_range` (boolean, optional, default: false) — Ignore the default 45-day date range and retrieve all terminations ## Response ### 200 Successfully retrieved list of offboarding - `data` (list of OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems, optional) — A list of offboarding items. - `page` (OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage, optional) ## Errors ### 400 Bad Request Error Bad request — invalid or malformed query parameters. - `errors` (list of OffboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems, required) — List of errors that occurred while processing the request. ### 401 Unauthorized Error Unauthorized — missing or invalid authentication token. - `any` ### 403 Forbidden Error Forbidden — caller lacks permission to view offboarding data. - `any` ### 404 Not Found Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ### 500 Internal Server Error Operation failed. - `request` (ApiErrorRequest, optional) - `errors` (list of ApiError, optional) ## Types ### OffboardingTrackerGetParametersPagination - `contractId` (string, optional) — Contract ID for pagination - `effectiveDate` (string, optional) — Effective date for pagination - `referenceDate` (string, optional) — Reference date for pagination - `progressStatusWeight` (integer, optional) — Progress status weight for pagination ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems - `name` (string, optional) — The name of the individual associated with the offboarding. - `contract` (OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract, optional) - `progress` (OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress, optional) - `unique_id` (string, optional) — Base64url-encoded JSON token identifying this offboarding tracker. Decodes to `{"contractOid":"","hiringType":""}`. Pass as the `id` path parameter to tracker detail or checklist endpoints. Obtain from the API — never construct manually. - `hiring_type` (string, optional) — The hiring type for the individual (e.g., contractor). - `hris_profile` (OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile, optional) - `app_experience` (OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience, optional) - `termination_id` (string, optional, nullable) — The termination ID if the individual has been terminated. - `offboarding_type` (enum, optional) — The type of offboarding. - Allowed values: `TERMINATION`, `RESIGNATION`, `ENDING_CONTRACT` ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage - `cursor` (string, optional, nullable) — Cursor for pagination to fetch the next page of contractors - `total_rows` (integer, optional) — The total number of contractors available ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems - `message` (string, required) — Human-readable explanation - `code` (string, optional) — Machine-readable error code ### ApiErrorRequest - `method` (string, optional) — The HTTP method of the failed request - `url` (string, optional) — The relative URL of the failed request - `status` (double, optional) — The status code of the response - `api_req_id` (string, optional) — The request ID of the failed request - `docs` (string, optional) — A link to the official documentation for the requested endpoint resource - `source` (string, optional) — The source handler which produced the returned error - `code` (double, optional) — The code of the source handler which produced the returned error ### ApiError - `message` (string, optional) — A description of the returned error - `path` (string, optional) — The JSON path where input validation failed ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract - `id` (string, optional) — The contract ID associated with the individual. ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress - `status` (string, optional) — The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS). - `reference_date` (string, optional, nullable) — The reference date for the offboarding status (e.g., the termination date). - `reference_date_type` (string, optional) — The type of reference date (e.g., END_DATE). - `reference_date_timezone` (string, optional, nullable) — The timezone of the reference date. ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile - `oid` (string, optional, nullable) — The object ID for the HRIS profile of the individual. Null for hiring types without an associated HRIS profile (e.g. contractor, EOR, PEO). ### OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience - `is_minimal_requirements` (boolean, optional) — Indicates whether the individual meets the minimal experience requirements for the role. ## Examples **Response** ```json { "data": [ { "name": "John Doo", "contract": { "id": "m7yg6zp" }, "progress": { "status": "OFFBOARDING_IN_PROGRESS", "reference_date": "2021-07-14T22:00:00+00:00", "reference_date_type": "2021-07-14T22:00:00+00:00", "reference_date_timezone": "Europe/Belgrade" }, "unique_id": "eyJjb250cmFjdE9pZCI6Im03eWc2enAiLCJoaXJpbmdUeXBlIjoiZW9yIn0", "hiring_type": "contractor", "hris_profile": { "oid": "b550b7e5-d6e1-4613-93ba-a7ee5f75887c" }, "app_experience": { "is_minimal_requirements": true }, "termination_id": "b550b7e5-d6e1-4613-93ba-a7ee5f75887c", "offboarding_type": "ENDING_CONTRACT" } ], "page": { "cursor": "eyJsaW1pdCI6MiwicGFnaW5hdGlvbiI6eyJwcm9ncmVzc1N0YXR1c1dlaWdodCI6MSwicmVmZXJlbmNlRGF0ZSI6IjIwMjEtMDctMThUMjI6MDA6MDArMDA6MDAiLCJlZmZlY3RpdmVEYXRlIjoiMjAyMS0wNy0xOFQyMjowMDowMCswMDowMCIsImNvbnRyYWN0SWQiOiJONzZsWHdreiJ9LCJzb3J0T3JkZXIiOiJBU0MifQ", "total_rows": 86 } } ``` **SDK Code** ```python import requests url = "https://api.letsdeel.com/rest/offboarding/tracker" querystring = {"cursor":"eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ","hiring_types":"[\"eor\"]","ignore_date_range":"false","include_overview":"false","limit":"50","pagination":"{\"contractId\":\"contract12345\",\"effectiveDate\":\"2024-01-01T00:00:00Z\",\"progressStatusWeight\":1,\"referenceDate\":\"2024-01-01T00:00:00Z\"}","progress_statuses":"[\"IN_REVIEW\"]","search":"John Doe","sort_by":"progressStatusWeight","sort_order":"DESC"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/offboarding/tracker?cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ&hiring_types=%5B%22eor%22%5D&ignore_date_range=false&include_overview=false&limit=50&pagination=%7B%22contractId%22%3A%22contract12345%22%2C%22effectiveDate%22%3A%222024-01-01T00%3A00%3A00Z%22%2C%22progressStatusWeight%22%3A1%2C%22referenceDate%22%3A%222024-01-01T00%3A00%3A00Z%22%7D&progress_statuses=%5B%22IN_REVIEW%22%5D&search=John+Doe&sort_by=progressStatusWeight&sort_order=DESC")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```