List visible accounts
Every account the key may see, sorted by name, each with its owner (the active owner as the guild page shows them, or null) and, for service keys, its account_hash. online, world and last_seen are null for accounts whose activity the key can’t read. meta.count is the number returned.
Authorization
bearerAuth An API key from the hub’s API keys page.
In: header
Query Parameters
Comma-separated display names, matched case-insensitively the way the game does (at most 100). With names and/or ids, only matching accounts are returned; names that match nothing are simply absent.
Comma-separated account ids (at most 100).
true: only accounts in game now; false: only accounts known to be offline. Accounts whose activity the key can’t read never pass this filter.
Value in
- "true"
- "false"
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/accounts?names=Zezima%2CLynx+Titan"{ "data": [ { "id": "string", "name": "string", "account_hash": "string", "type": 0, "type_label": "string", "owner": { "name": "string", "discord_id": "string" }, "online": true, "world": 0, "last_seen": "2019-08-24T14:15:22Z" } ], "meta": { "generated_at": "2019-08-24T14:15:22Z", "count": 0 }}The key and its creator GET
The key behind the request (kind, name, prefix, categories, scope, rate limit, expiry), its creator’s display name (`user`, null for a service key) and how many accounts it can see right now. Handy as a connection test.
One account’s current state GET
The account’s current state, section by section. A section of a category the key can’t read on this account is **omitted**; a readable section the player’s plugin never sent is `{ "shared": false, "updated_at": null }` ("not shared"), never an empty value. Every sent section carries `updated_at`.