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

# Search roles

GET https://api.sandbox.monite.com/v1/roles

Find all roles that match the search criteria.

Reference: https://docs.monite.com/api/roles/get-roles

## Authentication

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

## Servers

- `https://api.sandbox.monite.com/v1` (sandbox, default)
- `https://api.monite.com/v1` (eu_production)
- `https://us.api.monite.com/v1` (na_production)

## Request

### Query parameters

- `order` (enum, optional) — Sort order (ascending by default). Typically used together with the `sort` parameter.
  - Allowed values: `asc`, `desc`
- `limit` (integer, optional, default: 100) — The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.
- `pagination_token` (string, optional) — A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. If not specified, the first page of results will be returned.
- `sort` (enum, optional) — The field to sort the results by. Typically used together with the `order` parameter.
  - Allowed values: `updated_at`, `created_at`
- `id__in` (string, optional)
- `name` (string, optional)
- `created_at` (datetime, optional)
- `created_at__gt` (datetime, optional)
- `created_at__lt` (datetime, optional)
- `created_at__gte` (datetime, optional)
- `created_at__lte` (datetime, optional)

### Headers

- `x-monite-version` (string, required)
- `x-monite-entity-id` (string, required) — The ID of the entity that owns the requested resource.

## Response

### 200

Successful Response

- `data` (list of RoleResponse, required) — array of records
- `next_pagination_token` (string, optional) — A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page).
- `prev_pagination_token` (string, optional) — A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page).

## Errors

### 400 Get Roles Request Bad Request Error

Bad Request

- `error` (ErrorSchema, required)

### 401 Get Roles Request Unauthorized Error

Unauthorized

- `error` (ErrorSchema, required)

### 403 Get Roles Request Forbidden Error

Forbidden

- `error` (ErrorSchema, required)

### 406 Get Roles Request Not Acceptable Error

Not Acceptable

- `error` (ErrorSchema, required)

### 422 Get Roles Request Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 500 Get Roles Request Internal Server Error

Internal Server Error

- `error` (ErrorSchema, required)

## Types

### RoleResponse

- `id` (string, required) — UUID role ID
- `created_at` (datetime, required) — UTC datetime
- `updated_at` (datetime, required) — UTC datetime
- `name` (string, required) — Role name
- `permissions` (BizObjectsSchemaOutput, required) — Access permissions
- `status` (enum, required) — record status, 'active' by default
  - Allowed values: `active`, `deleted`

### ErrorSchema

- `message` (string, required)

### ValidationError

- `loc` (list of ValidationErrorLocItem, required)
- `msg` (string, required)
- `type` (string, required)

### BizObjectsSchemaOutput

- `objects` (list of RootSchemaOutput, optional) — List of objects

### ValidationErrorLocItem

### RootSchemaOutput

- `object_type`: `accounting_tax_rate`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `approval_policy`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `approval_request`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `comment`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `cost_center`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `counterpart`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `counterpart_vat_id`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `delivery_note`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `entity`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `entity_bank_account`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `entity_user`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `entity_vat_ids`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `export`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `ledger_account`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `mailbox`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `ocr_task`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `onboarding`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `overdue_reminder`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `payable`
  - `actions` (list of PayableActionSchema, optional) — List of actions
- `object_type`: `payables_purchase_order`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `payment_record`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `payment_reminder`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `person`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `product`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `project`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `receipt`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `receivable`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `reconciliation`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `role`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `tag`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `todo_task`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `todo_task_mute`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `transaction`
  - `actions` (list of ActionSchema, optional) — List of actions
- `object_type`: `workflow`
  - `actions` (list of ActionSchema, optional) — List of actions

### ActionSchema

- `action_name` (enum, optional) — Action name
  - Allowed values: `create`, `read`, `update`, `delete`
- `permission` (enum, optional) — Permission type
  - Allowed values: `allowed`, `allowed_for_own`, `not_allowed`

### PayableActionSchema

- `action_name` (enum, optional) — Action name
  - Allowed values: `create`, `read`, `update`, `delete`, `pay`, `approve`, `cancel`, `submit`, `create_from_mail`, `reopen`
- `permission` (enum, optional) — Permission type
  - Allowed values: `allowed`, `allowed_for_own`, `not_allowed`

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "id",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "name": "name",
      "permissions": {
        "objects": [
          {
            "object_type": "accounting_tax_rate",
            "actions": [
              {}
            ]
          }
        ]
      },
      "status": "active"
    }
  ],
  "next_pagination_token": "next_pagination_token",
  "prev_pagination_token": "prev_pagination_token"
}
```

**SDK Code**

```python
import requests

url = "https://api.sandbox.monite.com/v1/roles"

headers = {
    "x-monite-version": "2024-01-31",
    "x-monite-entity-id": "9d2b4c8f-2087-4738-ba91-7359683c49a4",
    "Authorization": "Bearer <token>"
}

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

print(response.json())
```

```javascript
const url = 'https://api.sandbox.monite.com/v1/roles';
const options = {
  method: 'GET',
  headers: {
    'x-monite-version': '2024-01-31',
    'x-monite-entity-id': '9d2b4c8f-2087-4738-ba91-7359683c49a4',
    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.sandbox.monite.com/v1/roles"

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

	req.Header.Add("x-monite-version", "2024-01-31")
	req.Header.Add("x-monite-entity-id", "9d2b4c8f-2087-4738-ba91-7359683c49a4")
	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.sandbox.monite.com/v1/roles")

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

request = Net::HTTP::Get.new(url)
request["x-monite-version"] = '2024-01-31'
request["x-monite-entity-id"] = '9d2b4c8f-2087-4738-ba91-7359683c49a4'
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.sandbox.monite.com/v1/roles")
  .header("x-monite-version", "2024-01-31")
  .header("x-monite-entity-id", "9d2b4c8f-2087-4738-ba91-7359683c49a4")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.sandbox.monite.com/v1/roles', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'x-monite-entity-id' => '9d2b4c8f-2087-4738-ba91-7359683c49a4',
    'x-monite-version' => '2024-01-31',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.sandbox.monite.com/v1/roles");
var request = new RestRequest(Method.GET);
request.AddHeader("x-monite-version", "2024-01-31");
request.AddHeader("x-monite-entity-id", "9d2b4c8f-2087-4738-ba91-7359683c49a4");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-monite-version": "2024-01-31",
  "x-monite-entity-id": "9d2b4c8f-2087-4738-ba91-7359683c49a4",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sandbox.monite.com/v1/roles")! 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()
```