Skip to main content
GET
/
api
/
v1
/
auth
/
users
/
role
/
{role}
List users by role (paginated)
curl --request GET \
  --url https://crypto.westminister.tech/api/v1/auth/users/role/{role} \
  --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"
  },
  {
    "id": "7a4301b0-e04b-4102-a999-b17dada65509",
    "email": "loice.juma@gmail.com",
    "phone_number": "+254723453285",
    "first_name": "Loice",
    "last_name": "Juma",
    "role": "vendor",
    "kyc_status": "pending"
  },
  {
    "id": "c02c70db-2f9e-4bc8-a665-2836f3e5fd4e",
    "email": "kosla.imran@gmail.com",
    "phone_number": "+254727648191",
    "first_name": "Kosla",
    "last_name": "Imran",
    "role": "vendor",
    "kyc_status": "pending"
  },
  {
    "id": "5c81c005-1c52-4e0d-85e2-862ee1cdd4d0",
    "email": "imran.kosla@gmail.com",
    "phone_number": "+254727648190",
    "first_name": "Imran",
    "last_name": "Kosla",
    "role": "vendor",
    "kyc_status": "pending"
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
role
enum<string>
required

Role to filter users by.

Available options:
customer,
vendor,
user

Query Parameters

​
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 with the specified role

​
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
string

Assigned role.

​
kyc_status
string

Current KYC status.