v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Users - merchant level

Get a list of users

Returns a list of users associated with the merchantId specified in the path.

To make this request, your API credential must have the following role:

  • Management API—Users read and write
get/merchants/{merchantId}/users

Path parameters

merchantIdstring required

Unique identifier of the merchant.

Query parameters

pageNumberinteger

The number of the page to fetch.

pageSizeinteger

The number of items to have on a page. Maximum value is 100. The default is 10 items on a page.

usernamestring

The partial or complete username to select all users that match.

Response

OK - the request has succeeded.

itemsTotalinteger required

Total number of items.

pagesTotalinteger required

Total number of pages.