GET `/api/v1/roles`

Roles, their default privileges and maximum account permissions.

Scope users:read
operationId adminRoles

The token needs the scope users:read, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

GET /api/v1/roles

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl

curl "https://vestoris.com/api/v1/roles" \
  -H "Authorization: Bearer $VESTORIS_TOKEN"

Python (requests)

import os, requests

r = requests.get(
    "https://vestoris.com/api/v1/roles",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/roles", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: RoleList. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`data`	list of Role	The records of this page or list.
`data[].role`	string	The stored role value.
`data[].label`	string	The role as screens show it.
`data[].summary`	string	What the role is for.
`data[].default_privileges`	list of string	The role's default privileges.
`data[].max_account_permissions`	list of string	The most this role can hold on any account.
`data[].sees_all_accounts`	boolean	True for oversight roles that see every account (Admin, Compliance, Operations).

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "role": "trader",
            "label": "Trader",
            "summary": "Works orders on the blotter.",
            "default_privileges": [
                "use_blotter",
                "export"
            ],
            "max_account_permissions": [
                "view",
                "trade"
            ],
            "sees_all_accounts": false
        }
    ]
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/roles"
}

On the screens

The same thing in the app is explained in: