List base shifts

get

{backendUrlScheme}://{backendUrlHost}/api/public/base-shift/list

This endpoint can be used to list base shifts. At least one selector must be provided: _id, startDate+endDate, templateIds, userIds, taskTypeIds, or tagIds. When startDate/endDate are provided, they define a time window and must be provided together

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_id

array of strings

Base shift ID(s)

_id

archived

boolean

Archived

templateIds

array of strings

Filter by shift template ID(s)

templateIds

planningConfigIds

array of strings

Filter by planning config ID(s)

planningConfigIds

userIds

array of strings

Filter by user ID(s)

userIds

startDate

number

Start of the time window as Unix timestamp in milliseconds. Must be provided together with endDate. Returns base shifts that overlap the provided window

endDate

number

End of the time window as Unix timestamp in milliseconds. Must be provided together with startDate. Returns base shifts that overlap the provided window. Maximum allowed window range is 365 days.

skip

number

Skip from index count (default: 0)

limit

number

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

sort

string

Field(s) to sort by (sort options : 1 for ascending, -1 for descending)

Headers

bsy-sid

string

required

Session ID

Responses

200Base shifts retrieved successfully

400Bad request, invalid filters or missing/invalid selector

401Unauthorized access, invalid or missing session ID