Retrieve Groups

get

https://{hostname}/api/talk/groups/v1/groups

This operation returns all groups in a tenant or a filtered list of groups according to the specified query parameters.

Authorization and Permissions

An OpenAm or UKG Authentication token is required to make a post.
The user must have content creation permission, which is granted by a Talk administrator.

Query Params

page-token

string

The page-token is a string that represents the continuation token for a token-based pagination response and is used to retrieve a particular page of results. If not specified, the first page of results is returned.

group-type

string

enum

The type of a group. feed and chat groups are currently supported with values of Feed or Chat, respectively. If a value is not specified, both feed and chat groups are returned.

Allowed:

sub-type

string

enum

Defaults to manual

The subtype of a group. Manually created and automated groups are currently supported with values of Manual or Automation, respectively. If a value is not specified, both manual and automation groups are returned.

Allowed:

group-access

string

enum

The type of group based on accessibility to be returned to the client. I.E public, private and closed.

Allowed:

count

number

The count of a paginated response, which specifies the number of posts to return per page. If not specified, a default of 100 posts is returned. The count cannot exceed 100.

string

The search string by which result should be filtered.

created-by

string

To filter the result by the owner, pass the ID of the user.

sort

string

The sorting which needs to be applied to result. For now, it supports name, createdDateTime, updatedDateTime. You can specify the sort order next to key, if not passed it will be considered as asc default

created-after

string

The date time post which all the groups created should be listed considering other filters

created-before

string

The date time before which all the groups created should be listed considering other filters

updated-after

string

The date time post which all the groups updated should be listed considering other filters

updated-before

string

The date time before which all the groups updated should be listed considering other filters

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully retrieved groups.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed. The same error is thrown when pageToken filters do not match with the query string filters

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

500The HTTP status code 500 Internal Server Error, thrown when the server is not able to process the request.