APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Contact Center
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
API Changelog

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.

GET/v1/groups
Query Parameters
orgId
string

List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.

filter
string

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.

attributes
string

The attributes to return.

sortBy
sting

Sorts the results based on displayName.

sortOrder
string

Results returned based on alphabetical order of ascending or descending.

includeMembers
boolean

optionally returns the members of the groups. The maximum members returned is 500.

startIndex
number

The index to start for group pagination

count
number

Specifies the desired number of search results per page.

Response Properties
totalResults
number

Total Number of groups returned in the response.

startIndex
number
itemsPerPage
number
groups
array[Group Response]

An array of group objects.

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

The total number of members in the group.

members
array[Member]

An array of members

id
string

PeopleId

type
string

The type of member

displayName
string
Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/groups{?orgId,filter,attributes,sortBy,sortOrder,includeMembers,startIndex,count}
Log in to try the API.
Header
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.
https://webexapis.com/v1/groups?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&filter=displayName%20eq%20%22Marketing%20Department%22&attributes=displayName&sortBy=displayName&sortOrder=ascending&includeMembers=false&startIndex=1&count=100
200 / OK
{
  "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"
        }
      ]
    }
  ]
}