Skip to main content

List all characters

Retrieve a paginated list of all characters in the domain.

Query Parameters
per_page integer

Possible values: 1 ≤ value ≤ 100

Number of results per page

page integer

Possible values: 1 ≤ value

Page number

status string

Possible values: [online, offline]

Filter characters by online status

gameserver_ids integer[]

Filter characters by game server IDs

Responses
200

successful operation

Schema — OPTIONAL
data object[] — OPTIONAL
player_uuid uuid — OPTIONAL

UUID of the player who owns this character

uuid uuid — OPTIONAL

Unique identifier for the character

game_id string — OPTIONAL

Game-specific identifier for the character

alternate_game_id string — OPTIONAL

Alternative game-specific identifier (e.g., EOS ID for ASA)

name string — OPTIONAL

Character's display name

avatar uri — OPTIONAL

URL to the character's avatar image

level integer — OPTIONAL

Character's level in the game

gender string — OPTIONAL

Possible values: [male, female]

Character's gender

groups (circular)[] — OPTIONAL

Groups/tribes the character belongs to

game_server object — OPTIONAL

Game server information

id integer — OPTIONAL

ID of the game server the character is associated with

serverlist_name string — OPTIONAL

Full server name as shown in server lists

website_name string — OPTIONAL

Short server name used on the website

short_name string — OPTIONAL

Server name used in Discord integrations

cluster_chat_name string — OPTIONAL

Server name used in cluster chat

activity object — OPTIONAL

Character activity information

status boolean — OPTIONAL

Whether the character is currently online

status_since date-time — OPTIONAL

When the character's current status began

minutes_online_streak integer — OPTIONAL

Current online streak in minutes

stats object — OPTIONAL

Character statistics

hours_played float — OPTIONAL

Total hours played

achievements object[] — OPTIONAL

Achievements earned by the character

task object — OPTIONAL

The task associated with this achievement

id integer — OPTIONAL
name string — OPTIONAL
score integer — OPTIONAL

Points awarded for this achievement

created_at date-time — OPTIONAL

Date and time when the achievement was earned

expires_at date-time — OPTIONAL

Date and time when the achievement expires (null if permanent)

status string — OPTIONAL

Possible values: [active, expired, permanent, end_of_session]

Current status of the achievement

created_at date-time — OPTIONAL

Date and time when the character was created

links object — OPTIONAL
first string — OPTIONAL
last string — OPTIONAL
prev string — OPTIONAL
next string — OPTIONAL
meta object — OPTIONAL
current_page integer — OPTIONAL
from integer — OPTIONAL
last_page integer — OPTIONAL
links object[] — OPTIONAL
url string — OPTIONAL
label string — OPTIONAL
active boolean — OPTIONAL
path string — OPTIONAL
per_page integer — OPTIONAL
to integer — OPTIONAL
total integer — OPTIONAL