List Users

GET

/api/Users

curl --request GET \
  --url https://example.com/api/Users \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of staff users for a merchant.

Authorizations

• Bearer

Parameters

Query Parameters

MerchantId

string format: uuid

Search

string

Page

integer format: int32

PageSize

integer format: int32

Responses

200

Paginated list of users.

Media type application/json

object

items

Array<object>

nullable

object

id

string format: uuid

merchantId

string format: uuid

email

string

nullable

firstName

string

nullable

lastName

string

nullable

fullName

string

nullable

role

string

Allowed values: Owner Admin Staff Viewer

isActive

boolean

lastLoginAt

string format: date-time

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "items": [
    {
      "role": "Owner"
    }
  ]
}