GET /api/v3/userGroup/{userGroupId}

Retrieves a single user group by its unique identifier

GetUserGroupV3
Use this endpoint to get the full details of a specific user group including its member list.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Path Parameters

Name Description Type Required
userGroupId Unique numeric identifier of the user group integer (int32) Required

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

UserGroupResponse
Property Description Type
description The user group description string
lastUpdated The last time a member was inserted, updated, or deleted from the group string (date-time)
memberCount The number of users in this group integer (int32)
userGroupId The user group identifier integer (int32)
userGroupName The user group name string
Example Response application/json
{  "description": "string",  "lastUpdated": "2026-06-29",  "memberCount": 1,  "userGroupId": 1,  "userGroupName": "string"
}
404 Not Found The requested resource was not found. Verify the ID or path is correct.