Usergroup Filtering

Use the following parameters to find user groups with specific properties. These filters help you quickly locate groups based on type and status.

Filter Parameters

Add these parameters to your API requests to filter user groups by their properties:

Parameter	Description
type	Show user groups of specific type: `A` — administrator group `C` — customer group
status	Show user groups with specific status: `A` — active `H` — hidden `D` — disabled

Example Requests

GET /usergroups?status=A

This request returns an array with all active user groups.

https://www.venddor.com.br/api/usergroups?status=A

GET /users?status=D&type=C

This request returns an array with all customer groups with the Disabled status.

https://www.venddor.com.br/api/users?status=D&type=C

Example Response

{
  "usergroups": {
    "3": {
      "usergroup_id": "3",
      "status": "A",
      "type": "C",
      "usergroup": "Premium Customers",
      "privileges": {
        "manage_catalog": "Y",
        "view_reports": "Y"
      }
    },
    "12": {
      "usergroup_id": "12",
      "status": "A",
      "type": "C",
      "usergroup": "Wholesale Buyers",
      "privileges": {
        "manage_catalog": "N",
        "view_reports": "N"
      }
    }
  }
}

Tip: For more complex filtering needs, you can combine both parameters to narrow down your results further.