Retrieve an adjustment

GET

/adjustments/:id

GET

/rest/adjustments/:id

curl https://api.letsdeel.com/rest/adjustments/123e4567-e89b-12d3-a456-426614174000 \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "file": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "your_file_name",
      "fileType": "pdf"
    },
    "title": "Your title here",
    "amount": "1234.56",
    "status": "open",
    "odp_only": true,
    "created_at": "2020-11-02T12:00:00.000Z",
    "updated_at": "2020-11-02T12:00:00.000Z",
    "contract_id": "m3jk2j",
    "description": "Your description here",
    "cycle_reference": "your_cycle_reference",
    "move_next_cycle": true,
    "date_of_adjustment": "2023-11-15T00:00:00.000Z",
    "actual_end_cycle_date": "2023-11-15T00:00:00.000Z",
    "adjustment_category_id": "c9cf4c2c0165f48f494415390c3b49",
    "actual_start_cycle_date": "2023-11-01T00:00:00.000Z"
  }
}

Retrieves a single adjustment by its id. Use it to track an adjustment after creation: approval happens inside Deel rather than over the API, so polling status is how a caller learns the outcome. Requires the adjustments:read scope.

Token scopes: adjustments:read

Authentication

AuthorizationBearer

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 -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

idstringRequired

Deel adjustment id.

Response

Successful operation.

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error