List and Search Groups
List groups in your organization. Adding the includeMembers
attribute set to true will return the group members. The total number of members returned is limited to 500. To page through the groups the startIndex
and count
parameters can be used. To search for a specific group the filter
parameter can be used.
SortBy id
or displayName
will sort the response list.
Query Parameters
List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.
Seaches the group by displayName with an operator and a value. The operators available are eq (equal) and sw (starts with). The only available attribute to specify for searching within groups is displayName.
The attributes to return.
Sorts the results based on displayName.
Results returned based on alphabetical order of ascending or descending.
optionally returns the members of the groups. The maximum members returned is 500.
The index to start for group pagination
Specifies the desired number of search results per page.
Response Properties
Total Number of groups returned in the response.
An array of group objects.
A unique identifier for the group.
The name of the group.
The ID of the organization to which this group belongs.
The timestamp indicating creation date/time of group
The timestamp indicating lastModification time of group
The total number of members in the group.
An array of members
PeopleId
The type of member
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. |
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. |
Header
Query Parameters
- orgIdstringList groups in this organization. Only admin users of another organization (such as partners) may use this parameter.
- filterstringSeaches the group by displayName with an operator and a value. The operators available are eq (equal) and sw (starts with). The only available attribute to specify for searching within groups is displayName.
- attributesstringThe attributes to return.
- sortBystingSorts the results based on displayName.
- sortOrderstringResults returned based on alphabetical order of ascending or descending.
- includeMembersbooleanoptionally returns the members of the groups. The maximum members returned is 500.
- startIndexnumberThe index to start for group pagination
- countnumberSpecifies the desired number of search results per page.
{ "totalResults": 3, "startIndex": 1, "itemsPerPage": 10, "groups": [ { "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" } ] } ] }