GET
/api/v1/server/suspensions
Request
Response
200
Success
You can order by startedAt (default), endAt or id.
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.
expiredbooleanrequiredWhether it has expired.
idstringrequiredUnique ID.
memberIdstringrequiredMember ID of the suspended member.
pointsintegerrequiredPoints it carries.
reasonstringrequiredWhy they were suspended.
serverIdstringrequiredServer ID.
startedAtintegerrequiredWhen it started.
startedBystringrequiredMember ID of who suspended them.
voidedbooleanrequiredWhether it has been voided.
endAtinteger | nullWhen it's scheduled to end. Missing for indefinite suspensions.
endedAtinteger | nullWhen it ended early.
endedBystring | nullMember ID of who ended it early.
endedReasonstring | nullWhy it ended early.
expiredAtinteger | nullWhen it expired.
voidReasonstring | nullWhy it was voided.
voidedBystring | nullMember ID of who voided it.
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 |