Skip to main content
GET
List users (vendor-scoped)

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Query Parameters

vendorId
string

Filter by vendor ObjectId

type
enum<string>

Filter by user type

Available options:
vendor,
staff,
merchant,
admin
approved
boolean

Filter by approval status

Search in email and vendor name

first
integer

Number of items to return (forward pagination)

Required range: 1 <= x <= 100
after
string

Cursor for forward pagination

last
integer

Number of items to return (backward pagination)

Required range: 1 <= x <= 100
before
string

Cursor for backward pagination

Response

List of users

success
enum<boolean>
Available options:
true
data
object