List users

GEThttps://app.speybooks.com/api/v1/admin/users

A paginated list of all platform users. Supports filtering by status and by admin flag, and a partial text search across email and name.

Filters

search: partial match on email or name
status: all (default), active, locked, inactive
isAdmin: all (default), true, false

Each user carries their linked organisation (if any) with id, name, and plan.

Response

200Paginated user list with organisation membership, login status, and MFA state.

Show response fields

usersarray<object>

Show child attributes

createdAtstringdate-time

emailstring

failedAttemptsinteger

fullNamestring

idinteger

isActiveboolean

isAdminboolean

lastLoginstringdate-time

lockedUntilstringdate-time

organisationobject

Show child attributes

idstring

namestring

planstring

totpEnabledboolean

RequestGET/v1/admin/userscurl

curl "https://api.speybooks.com/v1/admin/users?status=locked&page=1" \
  -H "Authorization: Bearer <admin-token>"

Response200

{
  "success": true,
  "data": {
    "users": [
      {
        "id": 12,
        "email": "user@example.com",
        "fullName": "John Smith",
        "isActive": true,
        "isAdmin": false,
        "totpEnabled": false,
        "failedAttempts": 5,
        "lockedUntil": "2026-02-19T12:00:00Z",
        "lastLogin": "2026-02-18T09:00:00Z",
        "createdAt": "2026-01-15T10:00:00Z",
        "organisation": {
          "id": "uuid-here",
          "name": "Smith Consulting",
          "plan": "sole_trader"
        }
      }
    ]
  },
  "meta": {
    "page": 1,
    "perPage": 20,
    "total": 1,
    "pages": 1
  }
}