Documentation
Users

Search users

Paginated full-text search for users, or fetch by IDs.

GET
/api/users

Query Parameters

query*string
limit*string
offset*string

Response Body

application/json

curl -X GET "https://loading/api/users?query=string&limit=string&offset=string"
{
  "data": {
    "total": 100,
    "query": "john",
    "ids": [],
    "limit": 10,
    "offset": 0,
    "items": [
      {
        "id": 1,
        "username": "johndoe",
        "display": "John Doe",
        "bio": "Full-stack developer",
        "pronoun": "he/him",
        "server": "my-server.com",
        "tags": [],
        "thumbnail": "https://cdn.my-server.com/thumb.png",
        "banner": null,
        "links": [
          {
            "label": "GitHub",
            "value": "https://github.com/johndoe"
          }
        ],
        "relations": {
          "out": "follow",
          "in": null
        },
        "public": "MCow...==",
        "followers": 42,
        "following": 17,
        "presence": {
          "status": "online",
          "text": null
        },
        "alias": [
          {
            "key": "iid",
            "value": "1@my-server.com"
          }
        ]
      }
    ]
  },
  "error": null,
  "time": 1680000000000,
  "request": "/api/endpoint"
}