Skip to main content
GET
/
api
/
v1
/
auth
/
users
/
search
Search Users
curl --request GET \
  --url https://crypto.westminister.tech/api/v1/auth/users/search \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "383f20af-5960-4374-a5c3-b7566ea8f771",
    "email": "tigger.germain@gmail.com",
    "phone_number": "+254723453286",
    "first_name": "Tigger",
    "last_name": "Germain",
    "role": "vendor",
    "kyc_status": "pending"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
query
string
required

Search term (matches name, email, or phone).

​
page_id
integer
required

Page number (1-based).

Required range: x >= 1
​
page_size
integer
required

Page size (between 5 and 10).

Required range: 5 <= x <= 10

Response

200 - application/json

List of users matching the search

​
id
string<uuid>

User ID.

​
email
string<email>

User email.

​
phone_number
string

Phone in E.164 format.

​
first_name
string

Given name.

​
last_name
string

Family name.

​
role
enum<string>

Assigned role. Admin can only be assigned via PUT /api/v1/auth/user/id/{id}/role by an existing admin.

Available options:
customer,
vendor,
subvendor,
user,
admin
​
kyc_status
string

Current KYC status.