## List all users

Retrieve a list of all users who are members of your merchant account.
This endpoint returns an array of user objects containing details about each user.

Common use cases for this endpoint:

- Auditing user access to your merchant account
- Identifying users who can perform actions on behalf of the merchant
- Managing user permissions and roles within the merchant account

## Endpoint signature

```http
POST https://api.reservepay.com/merchants/list-users HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>

{}
```

Returns: array

## Response attributes

### `user_id` (string)

**Always present**. The ID of the user. This can be used as an argument in other endpoints. E.g.: `remove-user`

### `name` (string)

**Always present**. The name of the user, as they set it in their profile. This name is informational only and has not been verified.

### `email` (string)

**Always present**. The email address of the user.

### `email_confirmed` (boolean)

**Always present**. Whether the user's email address has been confirmed. If it is `false`, they may not own this address, and their access will be limited.

Possible values:

- `true`
- `false`

### `mfa_enabled` (boolean)

**Always present**. Whether the user has enabled multi-factor authentication (MFA) for their account. This is set by the user in their profile settings.

Possible values:

- `true`
- `false`

### `role_id` (string)

**Always present**. The ID of the user's role within the merchant account. This can be used as an argument in other endpoints.

### `preferred_language` (string)

**Always present**. The user's preferred language for communication. This is set by the user in their profile settings.

## Errors common to all endpoints

### `UNHANDLED_ERROR`

This error occurs when the server encounters an unexpected internal error that
it cannot handle gracefully. This typically happens due to bugs, infrastructure
issues, or edge cases that weren't anticipated during development.

### `INVALID_ARGUMENTS`

This error occurs when the request contains invalid or missing parameters.
Common cases include missing required fields, or values that don't match the
expected format or type.

### `BAD_VERSION`

This error occurs when making requests to an API version that does not exist.
This commonly happens when using an outdated SDK or when the API version
specified in the request URL is incorrect.