GET
/api/v1/server/departments/{departmentId}/shift-types
Request
Response
200
Success
You can order by createdAt (default) 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:
ascdescResponse
200 Success. Results are paged and also include page, pageSize, total and totalPages.
createdAtintegerrequiredWhen it was created.
idstringrequiredUnique ID.
namestringrequiredShift type name.
requiredRolesstring[]requiredRole IDs allowed to start this type of shift. Empty means anyone.
serverIdstringrequiredServer ID, or department ID for department shift types.
discordRoleIdstring | nullDiscord role given while on this type of shift.
nicknamePrefixstring | nullNickname prefix added while on this type of shift.
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 |