Groups - List and Search Groups | Webex for Developers

List and Search Groups

List groups in your organization.

Set the includeMembers parameter to true to return group members. The total number of members returned is limited to 500.
Use the startIndex and count parameters to page through result set.
To search for a specific group use the filter parameter.
Use sortBy parameter to sort the responses by id or displayName.

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

Searches the group by displayName with an operator and a value. The available operators are eq (equal) and sw (starts with). Only displayName can be used to filter results.

attributes

string

The attributes to return.

sortBy

string

Sort the results based by group displayName.

sortOrder

string

Sort results alphabetically by group display name, in ascending or descending order.

includeMembers

boolean

Optionally return group members in the response. The maximum number of 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.

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

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{?orgId,filter,attributes,sortBy,sortOrder,includeMembers,startIndex,count}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
List groups in this organization. Only admin users of another organization (such as partners) may use this parameter.
filter
string
Searches the group by `displayName` with an operator and a value. The available operators are `eq` (equal) and `sw` (starts with). Only `displayName` can be used to filter results.
attributes
string
The attributes to return.
sortBy
string
Sort the results based by group `displayName`.
sortOrder
string
Sort results alphabetically by group display name, in ascending or descending order.
includeMembers
boolean
Optionally return group members in the response. The maximum number of members returned is 500.
startIndex
number
The index to start for group pagination.
count
number
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"
        }
      ]
    }
  ]
}