Get user groups

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/user-group

Returns a list of user groups 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.

  • id string

    User group ID filter.

    Multi-value supported. Example: value1;value2

  • type string

    User group type filter

    Values are GROUP or SUPER_GROUP.

  • name string

    Group name filter

  • description string

    Group description filter

  • creatorContactId string

    Contact ID of the user who created the group.

    Multi-value supported. Example: value1;value2

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer(int64)
    • type string

      Values are GROUP or SUPER_GROUP.

    • name string
    • description string
    • organizationId integer(int64)
    • creatorContactId integer(int64)
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/user-group 
curl \
 --request GET 'https://wyzio.app/api-v1/user-group'
Response examples (200) 
[
  {
    "id": 42,
    "type": "GROUP",
    "name": "string",
    "description": "string",
    "organizationId": 42,
    "creatorContactId": 42
  }
]