Skip to main content
GET
/
v1
/
api
/
superadmin
/
users
List all users with pagination and filters
curl --request GET \
  --url http://localhost:3091/v1/api/superadmin/users \
  --header 'Authorization: Bearer <token>'
{
  "totalPages": 123,
  "totalElements": 123,
  "first": true,
  "last": true,
  "size": 123,
  "content": [
    {
      "id": 123,
      "firstName": "<string>",
      "lastName": "<string>",
      "username": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "nationality": "<string>",
      "birthDate": "<string>",
      "enabled": true,
      "banned": true,
      "banReason": "<string>",
      "bannedAt": "2023-11-07T05:31:56Z",
      "roles": [
        "<string>"
      ],
      "walletBalance": 123,
      "pendingWithdrawalAmount": 123,
      "totalEarned": 123,
      "totalWithdrawn": 123,
      "stripeConnectedAccountId": "<string>",
      "stripeAccountComplete": true,
      "kycStatus": "PENDING",
      "kycSubmittedAt": "2023-11-07T05:31:56Z",
      "kycReviewedAt": "2023-11-07T05:31:56Z",
      "totalAnnonces": 123,
      "totalReservationsAsSender": 123,
      "totalReservationsAsCarrier": 123,
      "totalTransactions": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastLoginAt": "2023-11-07T05:31:56Z"
    }
  ],
  "number": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "pageable": {
    "offset": 123,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "paged": true,
    "pageNumber": 123,
    "pageSize": 123,
    "unpaged": true
  },
  "numberOfElements": 123,
  "empty": true
}

Authorizations

Authorization
string
header
required

JWT access token from POST /v1/api/auth/login

Query Parameters

role
string
enabled
boolean
banned
boolean
kycStatus
string
page
integer<int32>
default:0
size
integer<int32>
default:20
sortBy
string
default:createdAt
sortDirection
string
default:DESC

Response

Users retrieved

totalPages
integer<int32>
totalElements
integer<int64>
first
boolean
last
boolean
size
integer<int32>
content
object[]
number
integer<int32>
sort
object
pageable
object
numberOfElements
integer<int32>
empty
boolean