Import Shifts API

Import Shifts API

YouRecruit offers a public API which allows for importing the shifts into YouRecruit from any external resources. All that is necessary is to have the data in the correct format.

The API can import one shift per request or multiple shifts in one organisation within one request.

This API can also accept the name of Assigned Employee which allows automatically assigning the Employee to the shift.

The data can be submitted as JSON format (preferred) or standard HTTP POST. 

Each Request must be submitted with an authentication header that will authorise you with the access to data within your company.

It is possible to use the YouRecruit IDs, but from our experience it is usually too complicated to reach on the third party side. So we have made it also possible to use just the names and YouRecruit will transfer these names into the required IDs automatically in the background.

Example of the data for importing a shift into YouRecruit:

{
      "organization_name": "Hospital Name",
      "shift_status": "open",
      "shift_code": "abcdef123",
      "location_name": "Location Name",
      "cost_centre": "cost_centre",
      "date": "24/5/2023",
      "time_from": "08:00",
      "time_to": "16:00",
      "role_name": "Nurse",
      "employee_name": "Jerry Smith",
      "placement_count": 1
}

If the import is correct, we will respond with success 200 HTTP code. If there are any issues, we will report code 400 and give the details of what was not valid in the response.