GET
/api/v1/server/suspensions/{suspensionId}
Request
Response
200
Success
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Path parameters
suspensionIdstringrequiredResponse
200 Success
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 |
404 | Not found |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |