## List all roles

Retrieve a list of all roles available in the merchant account.
This endpoint returns the roles that can be assigned to users within the merchant account.
This includes default roles defined by the system as well as any custom roles created by the merchant.

## Endpoint signature

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

{}
```

Returns: array

## Response attributes

### `id` (string)

**Always present**. The unique identifier of the role.

### `name` (string)

**Always present**. The name of the role.

### `description` (string)

**Always present**. A brief description of the role's purpose and permissions.

### `custom` (boolean)

**Always present**. Indicates whether the role is a custom role created by the merchant or a default system role.

Possible values:

- `true`
- `false`

### `permissions` (array)

**Always present**. An array of permissions the role gives.

Possible values:

- `view_team`
- `view_settings`
- `view_contacts`
- `view_transactions`
- `view_statements`
- `view_payouts`
- `view_disputes`
- `manage_team`
- `manage_settings`
- `manage_contacts`
- `manage_transactions`
- `manage_payouts`
- `manage_developer_settings`
- `manage_terminals`
- `manage_disputes`

## 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.