Search Shifts

GET 
/api/v2/public/shifts

Error: ENOENT: no such file or directory, open '/app/dist/apps/public-api/v2/shifts/docs/search-shifts.md'

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: 2025-01-03T17:20:30.218Z
endDate 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: 2025-01-03T17:20:30.218Z
licenseTypes string
License Type of the shift
Example: RN
facilityIds string
Id of the facility
Example: NUR-1660331570
statuses string
Status of the Shift
Example: UnfulfilledRequested
shiftIds string
Id of the shift
Example: 5552536398

Responses

201

application/json

Schema

Schema

data object[]
Array [
shiftId stringrequired
Id of the shift
facilityId stringrequired
Id of the facility
from date-timerequired
When you provide date-time value, time is ignored and will take the start of the day for the given date (00:00:00)
to date-timerequired
When you provide date-time value, time is ignored and will take the start of the day for the given date (00:00:00)
licenseType stringrequired
License Type of the shift
status stringrequired
Status of the Shift
breakTime ISO 8601 duration
Break Time for the shift
billRatePerHour numberrequired
Price per hour
autoSchedulingEnabled booleanrequired
If auto scheduling is enabled for this shift
timekeepingAutomated booleanrequired
If timekeeping automation is enabled for this 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": [
    {
      "shiftId": "5552536398",
      "facilityId": "NUR-1660331570",
      "from": "2025-01-03T17:20:30.029Z",
      "to": "2025-01-03T17:20:30.029Z",
      "licenseType": "RN",
      "status": "Requested",
      "breakTime": "PT45M",
      "billRatePerHour": 47.5,
      "autoSchedulingEnabled": true,
      "timekeepingAutomated": true
    }
  ],
  "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",
    "endDate must be a valid ISO 8601 date 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...