List user groups

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/user-groups

User Groups

Last modified:2026-10-05 20:17:58

Maintainer:Not configured

Required Permission(s):settings-usergroups-read

Returns every user group sorted by name, with each user's name, email and avatar.

Requires a session token whose role has the settings-usergroups-read permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200All groups, sorted by name

application/json

All groups, sorted by name.

Bodyapplication/json

Example

[
    {
        "_id": "65f1c2a9e4b0a1b2c3d4e5aa",
        "name": "Seguridad MEX1",
        "users": [
            {
                "_id": "65f1c2a9e4b0a1b2c3d4e5e7",
                "firstname": "José María",
                "lastname": "Esparza Arévalo",
                "email": "jose.esparza@digitalignition.com.mx",
                "avatar": "https://lh3.googleusercontent.com/a/abc123"
            }
        ],
        "__v": 0
    }
]

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error

Modified at 2026-10-05 20:17:58

Overview

Create a user group