Roles

Get roles

Retrieves roles for corporation (default + custom).

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

Query parameters

page_numberinteger

PageNumber number

page_sizeinteger

Size of the page. If no page size is provided, default page size is used (25).

sort'name' | 'usage'

Sort parameter - "name" for ascending name sort (default) or "usage" for descending usage count sort

Response

OK

Example response

{
  "roles": [
    {
      "created_at": "2026-02-13T10:00:00Z",
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "Finance manager",
      "permissions": [
        "[\"TransactionCreate\"",
        "\"TransactionView\"]"
      ],
      "updated_at": "2026-02-13T10:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.