---
title: "Get roles"
method: GET
path: "/api/v1/roles"
tags: ["Roles"]
---

# Get roles

`GET /api/v1/roles`

## Request

- Base URL: `https://api-business.wirexapp.com`
- URL: `https://api-business.wirexapp.com/api/v1/roles`
- Auth: API key in header `Authorization`

Retrieves roles for corporation (default + custom).

## Query parameters

- `page_number` integer
- `page_size` integer
- `sort` 'name' | 'usage'

## Response `200`

OK

- ResponseRolesResponse
  - `roles` ResponseRoleResponse[], required
    - `created_at` string, required
    - `id` string, required
    - `is_global` boolean
    - `name` string, required
    - `permissions` string[], required
    - `updated_at` string, required

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/wirexapp/apis/wirex-corporate-baas-api.md) - [All operations](https://skmtc.dev/wirexapp/apis/wirex-corporate-baas-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wirexapp/apis/wirex-corporate-baas-api/revisions/6525bfbc8f99?raw)