Get Group Details

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-details

Overview

Returns one group by ID.

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

Parameter	Type	Required	Description
api_key	String	Yes (or auth_token)	API key authentication
auth_token	String	Yes (or api_key)	Auth token authentication
args	Object (JSON string)	Yes	Stringified object containing _id

args Object Fields

Field	Type	Required	Description
_id	String	Yes	Group ID

Examples

Example: Get one group

Endpoint form:

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

Decoded args object:

{
  "_id": "507f1f77bcf86cd799439011"
}

Response

Success Response

{
  "result": {
    "_id": "507f1f77bcf86cd799439011",
    "name": "Marketing Team",
    "groupID": "marketing-team",
    "global_admin": false,
    "users": ["507f191e810c19729de860ea"],
    "permission": {
      "_": { "u": [], "a": [] },
      "c": {},
      "r": {},
      "u": {},
      "d": {}
    }
  }
}

Response Fields

Field	Type	Description
result	Object or null	Matching group document
result.users	Array	Member IDs in the group
result.permission	Object	Stored group permission object

Error Responses

HTTP Status	Response
200	{ "result": "Not enough args" }
400	{ "result": "Missing parameter \"api_key\" or \"auth_token\"" }
400	Error object from details lookup path

Behavior

1. Parses args and validates _id.
2. Reads group from countly.groups.
3. Returns { "result": group }.

Related Endpoints

• Groups - List Groups
• Groups - Update Group
• Groups - Delete Group

Implementation details

Database Collections

Collection	Used for	Data touched by this endpoint
countly.groups	Endpoint data source	** - Group document source