Developers
Bessy.nl >

List shifts

get
{backendUrlScheme}://{backendUrlHost}/api/public/shift/list

This endpoint returns generated shifts (recurring instances of base shifts) within a requested date range. The maximum allowed date range is 31 days. In the request you provide a session ID in the header, a required startDate and endDate in the query, and optional filters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
_id
array of strings

Base Shift ID(s). Filters by base shift selector ID.

_id
userIds
array of strings

Filter by user ID(s)

userIds
taskTypeIds
array of strings

Filter by task type ID(s)

taskTypeIds
tagIds
array of strings

Filter by tag ID(s)

tagIds
number
required

Start of the requested date range in milliseconds

number
required

End of the requested date range in milliseconds

number

Skip from index count (default: 0)

number

Number of items to return (default: 10, max: 100)

string
Defaults to startTime

Field to sort by. Prefix with '-' for descending order. Default: startTime

Headers
string
required

Session ID

Responses

Updated 7 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago