Get Group Members
Gets the members of a group.
The default maximum members returned is 500.
Control parameters is available to page through the members and to control the size of the results.
GET/v1/groups/{groupId}/members
URI Parameters
groupId
stringrequired
A unique identifier for the group.
Query Parameters
startIndex
number
The index to start for group pagination.
count
number
Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.
Response Properties
id
string
A unique identifier for the group.
displayName
string
The name of the group.
orgId
string
The ID of the organization to which this group belongs.
created
string
The timestamp indicating creation date/time of group
lastModified
string
The timestamp indicating lastModification time of group
memberSize
number
members
array[Member]
An array of members
id
string
Person ID of the group member.
type
string
Member type.
displayName
string
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/groups//members{?startIndex,count}
Log in to try the API.
Header
Query Parameters
- The index to start for group pagination.
- Non-negative integer that specifies the desired number of search results per page. Maximum value for the count is 500.
https://webexapis.com/v1/groups/Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvYzY1ZjdkODUtYjY5MS00MmI4LWEyMGItODUzMDY0ZTFkNThiOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg/members?startIndex=1&count=100
200 / OK
{
"id": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvMjUxMDRiZTAtZjg3NC00MzQzLTk2MDctZGYwMmRmMzdiNWMxOjM0OGFkYjgxLTI4ZjktNGFiNS1iMmQ2LWU5YjQ5NGU3MmEwNg",
"displayName": "Sales Group",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8zNDhhZGI4MS0yOGY5LTRhYjUtYjJkNi1lOWI0OTRlNzJhMDY",
"created": "2022-02-17T02:13:29.706Z",
"lastModified": "2022-02-17T02:13:29.706Z",
"memberSize": 1,
"members": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xOTUzOTdhMi03MTU5LTRjNTgtYTBiOC00NmQ2ZWZlZTdkMTM",
"type": "user",
"displayName": "Jane Smith"
}
]
}