GET
/api/v1/server/departments
Request
Response
200
Success
You can order by id (default).
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Query 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.
iconstringrequiredIcon image URL.
idstringrequiredUnique ID.
namestringrequiredDepartment name.
serverIdstringrequiredServer the department belongs to.
activatedboolean | nullWhether the department is active.
discordGuildIdstring | nullDiscord server linked to the department.
joinCodestring | nullCode members use to join.
typeinteger | nullDepartment type.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |