Get roles

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://restapi.wyzio.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}
Close
GET /api-v1/role

Returns a list of roles based on the specified filters.

Headers

  • WEAL-TOKEN Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID

    ID of organization, for which the operation must be performed

Query parameters

  • pageNumber integer

    Page Number

    Default value is 1.

  • sortingField string

    Field to sort by

  • direction string

    Sorting direction

    Values are ASC or DESC. Default value is ASC.

  • sizePerPage integer

    Size per page

    Default value is 60.

  • type string

    Role type filter

    Values are ROLE or SUPER_ROLE.

  • realId string

    Real underlying role ID filter.

    Multi-value supported. Example: value1;value2

  • name string

    Role name filter

  • isDefault boolean

    Whether this is the default role

  • description string

    Role description filter

  • roleType string

    Role scope filter

    Values are ORGANIZATION or GLOBAL.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • type string

      Values are ROLE or SUPER_ROLE.

    • name string
    • isDefault boolean
    • description string
    • id integer(int64)
    • realId integer(int64)
    • roleType string

      Values are ORGANIZATION or GLOBAL.
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/role 
curl \
 --request GET 'https://wyzio.app/api-v1/role'
Response examples (200) 
[
  {
    "type": "ROLE",
    "name": "string",
    "isDefault": true,
    "description": "string",
    "id": 42,
    "realId": 42,
    "roleType": "ORGANIZATION"
  }
]