Search for users. The actual semantics of a user search are subject to change. For now, this simply fuzzy-matches on username.
GET /api/v1/user/search?q=tcoles HTTP/1.1
Accept: application/json
Authorization: Bearer ...
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
ETag: ...
{
"items": [
{
"id": "ce444aa0-7813-4790-aeaf-c974c7b8dc1e",
"username": "tcolesdev",
"avatar": "protected/us-west-2:ce444aa0-7813-4790-aeaf-c974c7b8dc1e/c90ecab2-b3fc-4c24-bc5b-e93eb9a1733c.png"
"emblem": null,
},
{
"id": "66a5db1f-2785-498d-9068-e24ddbba03f2",
"username": "tcoles+test01",
"avatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
"emblem": null,
"profile": "This is my profile!"
}
],
"page": 0,
"pageSize": 48,
"total": 2
}Authentication is not required for this method.
NONE
| Name | Description | Value |
|---|---|---|
| q | the search query; must be at least three characters | string |
| pageSize | the size of the page to return, by default 48; must be between 10 and 200 (inclusive) optional | number |
| page | the page to return, starting at 0; must be greater than or equal to 0 optional | number |
NONE
Successful responses are code 200 with data in the response body. Error responses are standard.
The response body is an array of UserInfo objects.
| Name | Description | Value |
|---|---|---|
| id | the ID of the user as a GUID with dashes | string |
| username | the user's username, which is unique | string |
| avatar | a media path to the user's avatar image file; will be null if no avatar has been set | string or null |
| emblem | the GUID of an emblem to display with the user's avatar, or null if none is selected | string or null |
| profile | a text description of this user, if public optional | string |