Skip to navigation
ModulesPlayer

List a player's characters

This endpoint is cached for 2 minutes in the USER cache source. See Caching.

This endpoint belongs to the PLAYER rate-limit bucket. See Throttling and Rate Limits.

This response can be restricted by player Access Rules.

It is recommended to request players by UUID. Username lookups can return 300 MultipleObjectsReturned with a multi-selector response when more than one player matches the query.

Returns the player’s characters keyed by character UUID.

Path parameters

usernamestringRequired
Username or UUID accepted by the player route.

Response

Character map keyed by character UUID.
typestring
reskinstring or null
nicknamestring or null
levelinteger
xpinteger
xpPercentinteger
totalLevelinteger
gamemodelist of strings
metaobject

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error