Skip to main content

Get Group Users

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint​

/o/groups/group-users

Overview​

Returns members in a group, or members outside a group when inverse is true.

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

  • Required access: global admin

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or auth_token)API key authentication
auth_tokenStringYes (or api_key)Auth token authentication
argsObject (JSON string)YesStringified object containing group query options

args Object Fields​

FieldTypeRequiredDescription
_idStringYesGroup ID used for filtering
inverseBooleanNoIf true, returns users not in the group

Examples​

Example 1: Members in a Group​

Endpoint form:

https://your-server.com/o/groups/group-users?api_key=YOUR_API_KEY&args={"_id":"507f1f77bcf86cd799439011"}

Example 2: Members Not in a Group​

Endpoint form:

https://your-server.com/o/groups/group-users?api_key=YOUR_API_KEY&args={"_id":"507f1f77bcf86cd799439011","inverse":true}

Response​

Success Response​

{
  "result": [
    {
      "_id": "507f191e810c19729de860ea",
      "full_name": "Jane Doe",
      "email": "jane.doe@example.com",
      "group_id": ["507f1f77bcf86cd799439011"],
      "global_admin": false
    }
  ]
}

Response Fields​

FieldTypeDescription
resultArrayMatching members
result[]ObjectMember object (password is excluded)
result[].group_idArrayMember group assignments

Error Responses​

HTTP StatusResponse
200{ "result": "Not enough args" }
400{ "result": "Missing parameter \"api_key\" or \"auth_token\"" }
400Error object from members query path

Behavior​

  1. Parses args and validates _id.
  2. Builds query:
    • inverse=false or omitted: { "group_id": "<group_id>" }
    • inverse=true: { "group_id": { "$ne": "<group_id>" } }
  3. Returns members as { "result": [...] }.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersEndpoint data source** - Source of returned member list