List merchant users

Retrieves a paginated list of merchant users with support for filtering by various attributes and sorting options

GET/api/v1/{team_slug}/{app_slug}/merchant-users

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/merchant-users

Retrieves a paginated list of merchant users with support for filtering by various attributes and sorting options

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/merchant-users
Summary: List merchant users
Description: Retrieves a paginated list of merchant users with support for filtering by various attributes and sorting options
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters19 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
page	query	No	integer	Page number (default: 1)
per-page	query	No	integer	Items per page (default: 20, max: 100)
sort-key	query	No	string	Sort field (email, market, language_code, store_group, first_name, last_name, created_at, status)
sort-order	query	No	string	Sort direction (asc, desc, default: desc)
search	query	No	string	Search term
market	query	No	string[]	Filter by market
language	query	No	string	Filter by language
store_group	query	No	string[]	Filter by store group
email	query	No	string	Filter by email
name	query	No	string	Filter by name
surname	query	No	string	Filter by surname
status	query	No	string	Filter by status (active, pending, inactive)
email_verified	query	No	boolean	Filter by email verification status
created_at_before	query	No	string	Filter by creation date before (YYYY-MM-DD format, e.g., 2024-05-11)
created_at_after	query	No	string	Filter by creation date after (YYYY-MM-DD format, e.g., 2024-05-11)
has_organisation	query	No	boolean	Filter by if merchant user is attached to an organisation
custom_role_slugs	query	No	string[]	Filter by custom role slugs

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses

Status	Description	Content
200	List of merchant users	application/json (object)
400	Invalid request (e.g. bad parameters, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
500	Internal server error	application/json (object)

200 - object

Merchant User List

Property	Type	Required	Details
`data`	object	No	-
`success`	boolean	No	-
`total`	integer	No	-
`total_pages`	integer	No	-

Merchant User

Property	Type	Required	Details
`count`	integer	No	-
`pages`	integer	No	-
`users`	object[]	No	-

Merchant User

Property	Type	Required	Details
`additions`	object	No	-
`address`	object	No	-
`address_restrictions`	object[]	No	-
`app_id`	string	No	-
`attributes`	object[]	No	-
`comment`	string	No	-
`communication_preferences`	object	No	-
`created_at`	string	No	-
`customer_groups`	object[]	No	-
`email`	string	No	-
`email_verification_sent_at`	string	No	-
`email_verified`	boolean	No	-
`id`	string	No	-
`is_super_admin`	boolean	No	-
`language`	string	No	-
`market`	string	No	-
`name`	string	No	-
`organisations`	object[]	No	-
`phone_number`	string	No	-
`status`	string	No	-
`store_group`	string	No	-
`surname`	string	No	-
`tags`	object[]	No	-
`updated_at`	string	No	-

{
  "data": {
    "count": 0,
    "pages": 0,
    "users": [
      {
        "additions": {},
        "address": {
          "city": null,
          "country": null,
          "country_code": null,
          "street": null,
          "zip_code": null
        },
        "address_restrictions": [],
        "app_id": "string",
        "attributes": [],
        "comment": "string",
        "communication_preferences": {
          "allow_email": null,
          "allow_postal": null,
          "allow_sms": null
        },
        "created_at": "string",
        "customer_groups": [],
        "email": "string",
        "email_verification_sent_at": "string",
        "email_verified": false,
        "id": "string",
        "is_super_admin": false,
        "language": "string",
        "market": "string",
        "name": "string",
        "organisations": [],
        "phone_number": "string",
        "status": "string",
        "store_group": "string",
        "surname": "string",
        "tags": [],
        "updated_at": "string"
      }
    ]
  },
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/merchant-users
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Merchant Users
OpenAPI summary: List merchant users