> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.thepennyinc.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.thepennyinc.com/_mcp/server.

# List preset roles

GET https://sandbox.api.thepennyinc.com/access/roles/global

List the preset roles Penny provides for every business. Assign them like custom roles; they can't be modified.

Required permissions: `role:list`.

Reference: https://docs.thepennyinc.com/api-reference/penny-banking/access/roles/presets/list

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://sandbox.api.thepennyinc.com` (Sandbox — safe for testing, no real money movement., default)
- `https://live.api.thepennyinc.com` (Live — real businesses, real money movement.)

## Request

### Query parameters

- `active` (boolean, optional, nullable) — Filter roles by active state.
- `page_size` (integer, optional, default: 100) — Maximum number of results to return per page. Defaults to 100.
- `next_page_token` (string, optional, nullable) — Pagination key used to retrieve the next page of results.

### Headers

- `X-Penny-As-Business` (string, optional, nullable) — Act on behalf of another business that has granted you access. Requires the `business:act_as` permission.

## Response

### 200

The matching preset roles.

- `items` (list of GlobalRole, required) — The list of items returned by the API.
- `count` (integer, required) — The total number of items returned in this response.
- `next_page_token` (string, optional, nullable) — A token for retrieving the next page of results, if applicable.

## Errors

### 400 Bad Request Error

The request was malformed: a required field is missing or a value has the wrong type or format.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 401 Unauthorized Error

Authentication failed.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 403 Forbidden Error

The caller does not have permission to perform this action.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 422 Unprocessable Entity Error

The request was well-formed but could not be processed because it breaks a business rule.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 429 Too Many Requests Error

Too many requests; retry after the Retry-After header.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

### 500 Internal Server Error

An unexpected error occurred.

- `type` (string, required) — The name of the exception that was raised.
- `message` (string, required) — A human-readable description of the error.
- `details` (map from string to any, optional, nullable) — Structured context about the error, if any.
- `trace_id` (string, optional, nullable) — Identifier for correlating this error with server-side logs.
- `errors` (list of map from string to any, optional, nullable) — Sub-errors that contributed to this failure, if any.

## Types

### GlobalRole

A preset role Penny provides for every business. Assign it like a custom role; it can't be modified.

- `role_id` (string, required) — Unique identifier for this preset role.
- `version` (integer, required) — Monotonically increasing version counter for optimistic concurrency control.
- `version_time` (datetime, required) — Timestamp of the most recent version update.
- `type` (enum, required) — Whether this is a custom role owned by your business (`business`) or a preset role Penny provides for every business (`global`).
  - Allowed values: `business`, `global`
- `name` (string, required) — Human-readable name for the role.
- `description` (string, required) — Human-readable description of the role's purpose and granted access.
- `active` (boolean, required) — Whether this role is currently active and can be assigned.
- `permissions` (list of PermissionResponse, required) — The set of permissions granted to principals holding this role.

### PermissionResponse

A permission specifying the resource and action a user or application can access.

- `resource` (enum, required) — The resource type this permission applies to.
  - Allowed values: `business`, `sub_business`, `business_entity`, `business_defaults`, `user`, `role`, `permission`, `application`, `verification`, `account`, `ledger`, `transaction`, `card`, `cardholder`, `card_product`, `bin`, `spend_control`, `simulation`, `fee`, `program`, `task`, `notification_endpoint`, `notification_event`, `notification_decision_exchange`, `*`
- `action` (enum, required) — The action permitted on the resource.
  - Allowed values: `read`, `list`, `create`, `update`, `delete`, `execute`, `act_as`, `reveal`, `*`

## Examples

**Response**

```json
{
  "items": [
    {
      "role_id": "global_role_019372e1-8a44-7c1d-9b2e-3f5a6c7d8e9f",
      "version": 1,
      "version_time": "2024-01-15T10:30:00Z",
      "type": "business",
      "name": "Viewer",
      "description": "Read-only access to your business's resources.",
      "active": true,
      "permissions": [
        {
          "resource": "account",
          "action": "read"
        }
      ]
    }
  ],
  "count": 1,
  "next_page_token": "string"
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.api.thepennyinc.com/access/roles/global"

headers = {
    "X-Penny-As-Business": "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox.api.thepennyinc.com/access/roles/global';
const options = {
  method: 'GET',
  headers: {
    'X-Penny-As-Business': 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.thepennyinc.com/access/roles/global"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.api.thepennyinc.com/access/roles/global")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Penny-As-Business"] = 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.api.thepennyinc.com/access/roles/global")
  .header("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.api.thepennyinc.com/access/roles/global', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Penny-As-Business' => 'business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.api.thepennyinc.com/access/roles/global");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Penny-As-Business", "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Penny-As-Business": "business_01a083e2-82ed-7a5c-9d1e-3b6f0c2a4d71",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.api.thepennyinc.com/access/roles/global")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```