POST
/
security
/
merchantUsers
/
getAll
cURL
curl -X POST "https://api.onekhusa.com/sandbox/v1/security/merchantUsers/getAll" \
  --header "Authorization: Bearer your-jwt-token" \
  --header "Content-Type: application/json" \
  --header "X-Organisation-Id: FYH0NTVW0DXK" \
  --header "X-Merchant-Account-Number: 35253486" \
  --header "Accept-Language: en" \
  -d '{
    "merchantAccountNumber": 35253486,
    "pageNumber": 1,
    "numberOfReturnedRows": 20,
    "isIncremental": false,
    "searchBy": "FirstName",
    "searchText": "John"
  }'
[
  {
    "userId": "user-id-456",
    "firstName": "Jane",
    "lastName": "Smith",
    "emailAddress": "jane.smith@example.com",
    "phoneNumber": "0881234567",
    "isEmailConfirmed": true,
    "roleName": "Merchant Administrator",
    "statusCode": "A",
    "statusName": "Active",
    "capturedBy": "admin@example.com",
    "dateCaptured": "2025-11-13T07:25:46.877Z",
    "modifiedBy": "user@example.com",
    "dateModified": "2025-11-13T07:25:46.877Z"
  },
  {
    "userId": "user-id-123",
    "firstName": "John",
    "lastName": "Doe",
    "emailAddress": "john.doe@example.com",
    "phoneNumber": "0881234567",
    "isEmailConfirmed": true,
    "roleName": "Merchant Administrator",
    "statusCode": "A",
    "statusName": "Active",
    "capturedBy": "admin@example.com",
    "dateCaptured": "2025-11-01T10:30:00.000Z",
    "modifiedBy": "admin@example.com",
    "dateModified": "2025-11-03T09:15:00.000Z"
  }
]

Authorizations

ā€‹
Authorization
string
header
required

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

Headers

ā€‹
X-Organisation-Id
string
required

The organization identifier

ā€‹
X-Merchant-Account-Number
string
required

The merchant account number

ā€‹
Accept-Language
string
default:en

Preferred language for the response

Body

application/json
ā€‹
merchantAccountNumber
integer
required

The unique identifier of the merchant account

Required range: 10000000 <= x <= 99999999
Example:

35253486

ā€‹
pageNumber
integer
required

The page number to retrieve (1-based)

Required range: x >= 1
Example:

1

ā€‹
numberOfReturnedRows
integer
required

The number of rows to return per page

Required range: x >= 1
Example:

20

ā€‹
isIncremental
boolean
required

If true, returns all rows up to and including the specified page. If false, returns only the rows for the specified page

Example:

false

ā€‹
searchBy
string

The field name to search by (defaults to "FirstName" if not provided). Supported fields include: FirstName, LastName, EmailAddress, PhoneNumber, RoleName, StatusCode, StatusName, etc.

Example:

"FirstName"

ā€‹
searchText
string

The text to search for (case-insensitive). Defaults to empty string if not provided. If empty, no search filtering is applied

Example:

"John"

Response

200 - application/json

Success - List of merchant users retrieved

An array of merchant user objects. Returns an empty array if no users exist for the merchant account

ā€‹
userId
string

The unique identifier of the user

Example:

"user-id-123"

ā€‹
firstName
string

The first name of the user

Example:

"John"

ā€‹
lastName
string

The last name of the user

Example:

"Doe"

ā€‹
emailAddress
string<email>

The email address of the user

Example:

"john.doe@example.com"

ā€‹
phoneNumber
string

The phone number of the user. May be an empty string if not set

Example:

"0881234567"

ā€‹
isEmailConfirmed
boolean

Indicates whether the user's email address has been confirmed

Example:

true

ā€‹
roleName
string

The human-readable description of the user's role

Example:

"Merchant Administrator"

ā€‹
statusCode
string

The status code of the merchant user account (e.g., "A" for Active, "I" for Inactive, "C" for Closed)

Example:

"A"

ā€‹
statusName
string

The human-readable status name of the merchant user account

Example:

"Active"

ā€‹
capturedBy
string

The username or identifier of the user who created this merchant user association

Example:

"admin@example.com"

ā€‹
dateCaptured
string<date-time>

The date and time when the merchant user association was created in UTC format

Example:

"2025-11-01T10:30:00.000Z"

ā€‹
modifiedBy
string | null

The username or identifier of the user who last modified the merchant user. May be null or empty if never modified

Example:

"admin@example.com"

ā€‹
dateModified
string<date-time> | null

The date and time when the merchant user was last modified in UTC format. May be null if never modified

Example:

"2025-11-03T09:15:00.000Z"