Get Scheduled Shifts

GET 
/api/v2/public/scheduled-shifts

Returns an array of shifts with the Scheduled status from facilities the user is connected to.

Request

Query Parameters

limit number
Possible values: <= 100
Default value: 10
Pagination parameter, use to specify the quantity of records returned
Example: 10
offset number
Default value: 0
Pagination parameter, use to specify the number of records to skip before starting to return results
Example: 10
sortDirection string
Possible values: [ASC, DESC]
Default value: DESC
Pagination parameter, use to specify the order of records by creation date, either 'asc' for ascending or 'desc' for descending
Example: DESC
startDate date-time
When you provide date-time value, time is ignored and will take the start of the day for the given date (00:00:00)
Example: 2024-09-13T18:48:23.283Z
licenseType string
License Type of the shift
Example: RN
facilityId stringrequired
Id of the facility
Example: NUR-1660331570
shiftId string
Id of the shift
Example: 5552536398

Responses

201

application/json

Schema

Schema

data object[]
Array [
shifts object[]required
Array containing shifts data
Array [
facilityId stringrequired
Id of the Facility
shiftId stringrequired
Id of the shift
from date-timerequired
Shift start date
to date-timerequired
Shift end date
licenseType stringrequired
License Type of the shift
clinician objectrequired
id stringrequired
Id of the clinician
firstName stringrequired
First name of the clinician
lastName stringrequired
Last name of the clinician
contactEmail stringrequired
Email of the clinician
contactPhone +1##########required
Contact Phone of the clinician
breakTime ISO 8601 duration
Break Time for the shift
]
]
meta object

limit numberrequired

Number of items returned

offset numberrequired

Starting position

sortDirection objectrequired

Sorting direction

total numberrequired

Total records found

Example (from schema)

{
  "data": [
    {
      "shifts": [
        {
          "facilityId": "NUR-123456",
          "shiftId": "1100482364",
          "from": "2024-09-13T00:00:00.000Z",
          "to": "2024-09-14T00:00:00.000Z",
          "licenseType": "RN",
          "clinician": {
            "id": "I7002epLHLhBCypdPCrn9XP4kTN2",
            "firstName": "Jane",
            "lastName": "Doe",
            "contactEmail": "jane@doe.com",
            "contactPhone": "+12345678910"
          },
          "breakTime": "PT45M"
        }
      ]
    }
  ],
  "meta": {
    "limit": 0,
    "offset": 0,
    "sortDirection": {},
    "total": 0
  }
}

400

Bad request

application/json

Schema

Schema

message string[]

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": [
    "Property must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

Request Validation

Request Validation Error

{
  "message": [
    "limit must be a number conforming to the specified constraints",
    "limit must not be less than 0",
    "limit must not be greater than 50",
    "offset must be a number conforming to the specified constraints",
    "offset must not be less than 0",
    "sortDirection must be one of the following values: ASC, DESC",
    "startDate must be a valid ISO 8601 date string",
    "facilityId must be a string",
    "shiftId must be a string"
  ],
  "error": "Bad Request",
  "statusCode": 400
}

401

Unauthorized

application/json

Schema

Schema

message string

Error description

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Unauthorized",
  "statusCode": 401
}

403

Forbidden

application/json

Schema

Schema

message string

Error description

error string

The type of error

statusCode integer

Status code of the error

Example (from schema)

{
  "message": "Forbidden Resource",
  "error": "Forbidden",
  "statusCode": 403
}

Loading...