Get all users

List every user in the site, returning their public profile fields. Sensitive fields (email, role, password hash, authentication token) are not returned.

Requires the API Token. See Authentication.

HTTP Request

GET /api/users

Parameters

Response

HTTP Code: 200
Content-Type: application/json
Body:
{
  "status": "0",
  "message": "Users profiles.",
  "data": {
    "admin": {
      "username": "admin",
      "firstName": "",
      "lastName": "",
      "nickname": "",
      "description": "",
      "twitter": "",
      "facebook": "",
      "instagram": "",
      "github": "",
      "gitlab": "",
      "linkedin": "",
      "mastodon": "",
      "bluesky": "",
      "youtube": "",
      "profilePicture": ""
    }
  }
}

data is an object keyed by username. See Get a user for the full set of profile fields.

CURL command example

$ curl -X GET "https://www.example.com/api/users?token=<api-token>"