modl.gg
Developer API

Get Player Notes

Get a player's notes with pagination.

GET /v1/minecraft/players/{uuid}/notes

Retrieve a paginated list of notes for a specific player.

Authentication

Requires the X-API-Key header with your server's API key.

X-API-Key: your-api-key-here

Request

Headers

HeaderTypeRequiredDescription
X-API-KeystringYesYour server's API key.

Path Parameters

ParameterTypeRequiredDescription
uuidstringYesThe player's Minecraft UUID.

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoThe page number (min: 1). Defaults to 1.
limitintegerNoThe number of results per page (min: 1, max: 100). Defaults to 7.

Example

GET /v1/minecraft/players/550e8400-e29b-41d4-a716-446655440000/notes?page=1&limit=10

Response

200 OK

{
  "status": 200,
  "notes": [
    {
      "text": "Player was warned verbally about chat behavior",
      "issuerName": "StaffMember",
      "createdAt": 1699000000000
    }
  ]
}

Error Responses

Status CodeDescription
401Missing or invalid API key.
404Player not found for the given UUID.
429Rate limit exceeded.
500Internal server error.

On this page