GET
/api/v1/server/departments/{departmentId}/shifts
Request
Response
200
Success
You can order by createdAt (default), endedAt or id.
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Path parameters
departmentIdstringrequiredQuery parameters
pageintegerdefault: 11-based page number. Defaults to 1.
pageSizeintegerdefault: 10Items per page, clamped to 1-100. Defaults to 10.
orderBystringField to sort by. See the endpoint description for the accepted values.
sortstringSort direction. Defaults to
desc.Allowed values:
ascdescactivebooleantrue for shifts in progress, false for ended shifts.typestringOnly shifts of this shift type ID.
Response
200 Success. Results are paged and also include page, pageSize, total and totalPages.
breakTimestampsobject[]requiredBreaks taken, oldest first. See the break object.
createdAtintegerrequiredWhen the shift started.
idstringrequiredShift ID.
memberIdstringrequiredMember ID of the member on shift.
serverIdstringrequiredServer ID, or department ID for department shifts.
waveintegerrequiredActivity wave the shift counts towards.
autoEndboolean | nullWhether the shift ends automatically.
endedAtinteger | nullWhen the shift ended. Missing while it's active.
endedBystring | nullMember ID of who ended it, if not the member.
typestring | nullShift type ID. Missing for the default type.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
404 | Not found |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |