GET /api/v1/users
searchUsers
needs people:read
curl https://api.acyka.cc/api/v1/users?q=frieren&limit=10 \
-H "Authorization: Bearer $ACYKA_TOKEN"Asking #
Narrowing it
| field | type | what it is |
|---|---|---|
q may be absent | string | undefined | what to search for |
limit may be absent | number | undefined | how many rows, 1-100; 30 by default |
Answering #
200 Page<Person> a page: items, and total beside it
The shapes #
Person #
Somebody, as small as a person gets on this door.
The site draws a person with `Name` or `Identity` and hands those components a whole `Wearer` — the colour, the badges, the pattern, the presence. None of that is here, and leaving it out is the decision rather than an omission: a badge is a thing this site invented and may re-invent, and a client that has built a row around `worn.hue` is a client we would have to keep it for.
| field | type | what it is |
|---|---|---|
nickname | string | |
avatar may be absent | string | undefined | |
verified | boolean |
When it says no #
A refusal is { "message": "errors.something" } — a phrase name and never a
sentence, because one screen can be read in five languages. Every library turns the name into a
type, so you catch the class you can do something about. Errors has
the list.