Lists and search
Every list is read through the search — the same search the dzbot admin area uses. There is one endpoint per type of list.
GET /api/admin/search/{type}// ParametersAsking for rows
| Parameter | Meaning |
|---|---|
q | Free text: a name, a code such as 7KQM, an id |
| filter keys | Per type, for example status=pending&status=delivered, player=1609285, created=7d or created=2026-10-01..2026-10-07, price=100..500 |
sort | A sort key, -key for descending, or relevance |
page, limit | The page (from 1) and its size |
ids | Only these rows (repeat the key) |
facets | Count rows per value of these filters (repeat the key) |
Players, factions, tickets and other references are always their numeric id, never a name: find a player by name with q on the player type, then filter by the id. Dates are read in the server's time zone unless they carry an offset.
curl "https://api.dzbot.de/api/admin/search/order?status=pending&created=7d&sort=-created" \ -H "Authorization: Bearer dzb_your_key_here" \ -H "X-Server-Subdomain: your-server"
// ResponseWhat comes back
The answer holds items (each with id, code, label, path and the row's fields), page (total, perPage, and whether the total is capped) and the applied filters.
// DiscoveryWhat you can ask
| Endpoint | Answers |
|---|---|
GET /api/admin/search/schema | Every type, filter and sort your key may use, with the options that depend on your server (groups, categories, the servers of your organization) |
GET /api/admin/search?q=… | The header search: the best hits of every type, grouped; capped says more match than the group shows |
The same three endpoints exist for every area of dzbot, each answering what that area shows: /api/admin/search (the admin area, including the organization pages), /api/search (a signed-in player), /api/public/search (guests and the wiki, no key needed), /api/platform-admin/search and /api/creators/search. An API key works on the admin endpoints.
// ErrorsWhen a search is refused
A filter your key's rights do not open is refused with 400 and names the parameter in param; a type it cannot read answers 403. The full list of types with their filters, sorts and fields is in the reference.