Skip to main content

Get Group Details

Endpoint​

/o/groups/group-details

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview​

Returns one group by ID.

Authentication​

  • Authentication methods:
    • API Key (parameter): api_key=YOUR_API_KEY
    • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
    • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

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 _id

args Object Fields​

FieldTypeRequiredDescription
_idStringYesGroup ID

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​

FieldTypeDescription
resultObject or nullMatching group document
result.usersArrayMember IDs in the group
result.permissionObjectStored group permission object

Error Responses​

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

Behavior/Processing​

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

Database Collections​

CollectionUsed forData touched by this endpoint
countly.groupsEndpoint data source** - Group document source

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"
}

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

Already a Customer? Use support portal if you have any questions

Last Updated​

2026-02-16