Get List of User Groups
    • Dark
      Light
    • PDF

    Get List of User Groups

    • Dark
      Light
    • PDF

    Article summary

    Get
    /api/v1/groups.listAll

    Lists all of the groups/channels of any users.

    Permission required: view-room-administration

    Changelog

    VersionDescription
    0.62.0Add 'query' parameter support.
    0.59.0Added
    Header parameters
    X-Auth-Token
    stringRequired

    The authToken of the authenticated user.

    ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
    X-User-Id
    stringRequired

    The userId of the authenticated user.

    ExamplerbAXPnMktTFbNpwtJ
    Query parameters
    offset
    integer

    Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.

    Example50
    count
    integer

    The number of items to return.

    Example50
    sort

    List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}

    query

    This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" } }

    fields
    string

    This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }

    Responses
    200

    OK

    Example 1
    {
      "groups": [
        {
          "_id": "xA52DRDM7dqx2PfTp",
          "name": "private1",
          "fname": "private1",
          "t": "p",
          "msgs": 0,
          "u": {
            "_id": "3WpJQkDHhrWPBvXuW",
            "username": "admin"
          },
          "customFields": {
            "companyId": "org1"
          },
          "ts": "2018-01-21T21:05:06.729Z",
          "ro": false,
          "sysMes": true,
          "_updatedAt": "2018-01-21T21:05:06.729Z"
        }
      ],
      "offset": 0,
      "count": 1,
      "total": 1,
      "success": true
    }
    Expand All
    object
    groups
    Array of object
    object
    _id
    string
    name
    string
    fname
    string
    t
    string
    msgs
    integer
    u
    object
    _id
    string
    username
    string
    customFields
    object
    companyId
    string
    ts
    string
    ro
    boolean
    sysMes
    boolean
    _updatedAt
    string
    offset
    integer
    count
    integer
    total
    integer
    success
    boolean

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.