GET
/api/v1/server/logs
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.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:
ascdesctypeintegerOnly logs of this type (0-5).
typeIdstringOnly custom logs of this custom type ID.
Response
200 Success. Results are paged and also include page, pageSize, total and totalPages.
createdAtintegerrequiredWhen it was created.
createdBystringrequiredMember ID of the staff member who created it, or
SYSTEM.editedBystring[]requiredMember IDs of everyone who edited it.
idstringrequiredUnique ID.
proofstring[]requiredProof file keys.
serverIdstringrequiredServer ID.
textstringrequiredReason.
typeintegerrequiredLog type:
0 Warning, 1 Kick, 2 Ban, 3 Ban BOLO, 4 Note or 5 Custom.usernamestringrequiredRoblox username of the player.
completedBystring | nullFor ban BOLOs, member ID of who completed it.
deniedBystring | nullFor ban BOLOs, member ID of who denied it.
descriptionstring | nullExtra details.
dontCountboolean | nullWhether it's left out of punishment counts.
expiredboolean | nullWhether it has expired.
expiredAtinteger | nullWhen it expired.
expiredBystring | nullMember ID of who expired it.
hiddenboolean | nullWhether it's hidden from the player.
hiddenBystring | nullMember ID of who hid it.
robloxIdstring | nullRoblox user ID of the player.
tempBanboolean | nullWhether the ban is temporary.
typeIdstring | nullCustom log type ID, when
type is 5.unbanAtinteger | nullWhen a temporary ban ends.
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 |