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

# List Business Roles

GET https://api.projectmanager.com/api/data/security/businessroles

Returns every business role in the current workspace, including built-in and custom roles.
            
Each role includes a permissions object with entitlement and grant state for the account security matrix.

Reference: https://developer.projectmanager.com/api-reference/security/list-business-roles

## Authentication

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

## Request

### Headers

- `x-integration-name` (string, optional) — The name of the calling system passed along as a header parameter

## Response

### 200

Success

- `error` (AstroError, optional, nullable) — If the API call failed, this will contain information about the error that occurred.
- `success` (boolean, optional) — True if the API call succeeded; false otherwise.
- `hasError` (boolean, optional) — True if the API call failed.
- `statusCode` (enum, optional) — The HTTP code of the response.
  - Allowed values: `Continue`, `SwitchingProtocols`, `Processing`, `EarlyHints`, `OK`, `Created`, `Accepted`, `NonAuthoritativeInformation`, `NoContent`, `ResetContent`, `PartialContent`, `MultiStatus`, `AlreadyReported`, `IMUsed`, `MultipleChoices`, `MovedPermanently`, `Found`, `SeeOther`, `NotModified`, `UseProxy`, `Unused`, `TemporaryRedirect`, `PermanentRedirect`, `BadRequest`, `Unauthorized`, `PaymentRequired`, `Forbidden`, `NotFound`, `MethodNotAllowed`, `NotAcceptable`, `ProxyAuthenticationRequired`, `RequestTimeout`, `Conflict`, `Gone`, `LengthRequired`, `PreconditionFailed`, `RequestEntityTooLarge`, `RequestUriTooLong`, `UnsupportedMediaType`, `RequestedRangeNotSatisfiable`, `ExpectationFailed`, `MisdirectedRequest`, `UnprocessableEntity`, `Locked`, `FailedDependency`, `UpgradeRequired`, `PreconditionRequired`, `TooManyRequests`, `RequestHeaderFieldsTooLarge`, `UnavailableForLegalReasons`, `InternalServerError`, `NotImplemented`, `BadGateway`, `ServiceUnavailable`, `GatewayTimeout`, `HttpVersionNotSupported`, `VariantAlsoNegotiates`, `InsufficientStorage`, `LoopDetected`, `NotExtended`, `NetworkAuthenticationRequired`
- `data` (BusinessRolesListDto, optional) — Business roles for the account security UI. Each role includes a permissions object whose keys are camelCase action names (for example invitePeople) with isGranted and subscription-related fields per row.

## Types

### AstroError

Information about an error that occurred within the ProjectManager API.

- `technicalError` (string, optional, nullable) — A technical description of the error that occurred. Not suitable for display to end users.
- `additionalErrors` (list of string, optional, nullable) — If additional errors beyond the main error in `Message` occurred, they will be listed here as individual messages.
- `validationErrors` (map from string to list of string, optional, nullable) — This contains a dictionary of validation errors. The key is the name of the field
- `message` (string, optional, nullable) — A description of the error that occurred. If your application has a user interface, show this message to explain what went wrong.

### BusinessRolesListDto

Business roles for the account security UI. Each role includes a permissions object whose keys are camelCase action names (for example invitePeople) with isGranted and subscription-related fields per row.

- `roles` (list of RoleDto, optional) — All business roles in the workspace, including built-in and custom roles.

### RoleDto

Workspace business role returned by the data API security endpoints (list/update responses and create response).

- `id` (string, optional) — Unique identifier of the business user role (`BusinessUserRoleId`).
- `name` (string, optional) — Display name of the role (e.g. Member, Manager, or a custom role name).
- `description` (string, optional, nullable) — Optional description; for system roles may match a well-known description token used server-side.
- `isGlobalAdmin` (boolean, optional) — True when this row is the non-editable global administrator role for the workspace.
- `isAdmin` (boolean, optional) — True when this role has account administrator privileges (non-guest elevated role).
- `isCustom` (boolean, optional) — True for user-defined roles; false for built-in system roles.
- `isDefault` (boolean, optional) — True when this role represents the default team member role for the workspace.
- `isGuest` (boolean, optional) — True when this role is the guest (client) role with restricted permissions.
- `permissions` (map from string to RolePermissionFeatureDto, optional) — Workspace security matrix. Keys are camelCase action names (for example invitePeople). Each entry includes isGranted and, when the action is subscription-gated, optional featureId and featureName.

### RolePermissionFeatureDto

One cell in the workspace role permissions matrix: grant state plus subscription / feature metadata when the action is Chargebee-gated.

- `isGranted` (boolean, optional) — Whether this permission is granted for the role in the workspace (persisted access).
- `isEntitled` (boolean, optional) — Whether the current workspace subscription entitles this action. May be false while isGranted is true for legacy data.
- `isFeatureEnabled` (boolean, optional) — Whether the feature flag for this permission is enabled for the workspace (display / upsell context).
- `featureId` (string, optional, nullable) — Primary Chargebee feature id used for entitlement (e.g. print-and-export), when applicable.
- `featureName` (string, optional, nullable) — Human-readable feature name for UI or documentation, when applicable.

## Examples

**Response**

```json
{
  "error": {
    "technicalError": "string",
    "additionalErrors": [
      "string"
    ],
    "validationErrors": {},
    "message": "string"
  },
  "success": true,
  "hasError": true,
  "statusCode": "Continue",
  "data": {
    "roles": [
      {
        "id": "string",
        "name": "string",
        "description": "string",
        "isGlobalAdmin": true,
        "isAdmin": true,
        "isCustom": true,
        "isDefault": true,
        "isGuest": true,
        "permissions": {}
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.projectmanager.com/api/data/security/businessroles"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript
const url = 'https://api.projectmanager.com/api/data/security/businessroles';
const options = {method: 'GET', headers: {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://api.projectmanager.com/api/data/security/businessroles"

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

	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://api.projectmanager.com/api/data/security/businessroles")

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

request = Net::HTTP::Get.new(url)
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://api.projectmanager.com/api/data/security/businessroles")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.projectmanager.com/api/data/security/businessroles', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.projectmanager.com/api/data/security/businessroles");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.projectmanager.com/api/data/security/businessroles")! 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()
```