Create time-off request

POST

/time_offs

POST

/rest/time_offs

curl -X POST https://api.letsdeel.com/rest/time_offs \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "data": {
    "end_date": "2021-04-30",
    "start_date": "2021-04-01",
    "recipient_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "reason": "Vacation",
    "is_paid": true,
    "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "amount": 30
  }
}'

{
  "time_offs": [
    {
      "is_paid": false,
      "end_date": "2021-08-01",
      "created_at": "2021-07-01T00:00:00Z",
      "start_date": "2021-07-01",
      "updated_at": "2021-07-01T00:00:00Z",
      "requested_at": "2021-07-01",
      "half_end_date": false,
      "half_start_date": false,
      "entitlement_unit": "CALENDAR_DAY",
      "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "amount": 1,
      "reason": "Vacation",
      "status": "REQUESTED",
      "approved_at": "2021-07-01T00:00:00Z",
      "attachments": [
        {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "filename": "vacation-request.pdf",
          "created_at": "2021-07-01T11:22:33Z",
          "updated_at": "2021-07-01T33:44:33Z"
        }
      ],
      "description": "Vacation",
      "contract_oid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "deduction_amount": 1,
      "time_off_dailies": [
        {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "date": "2021-07-01",
          "type": "WORKING_DAY",
          "amount": 1,
          "created_at": "2021-07-01T00:00:00Z",
          "updated_at": "2021-07-01T00:00:00Z",
          "time_off_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "description": "Vacation"
        }
      ],
      "recipient_profile": {
        "hris_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "client_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "requester_profile": {
        "organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "hris_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "client_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "time_off_percentage": 1,
      "is_end_date_estimated": false,
      "other_type_description": "Vacation",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    }
  ]
}

Creates a new time-off request for a worker.

Token scopes: time-off:write, worker:write

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/

Request

The time off request data

dataobjectOptional

The time off request data

Response

Time off creation data

time_offslist of objects

The list of created time offs. Depending on the selected dates, a time off can be split into more than one request.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error