Retrieve Group Users by ID

get

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

This operation returns all users of the specified group by group ID.

Authorization and Permissions

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

Path Params

groupId

string

required

A valid group ID in string format.

Query Params

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.

index

number

The index of a paginated response, which specifies the page number of the response. If not specified, a default of 0 is used.

isGroupAdmin

boolean

To filter the records that user is group admin or not

sort

string

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

Headers

x-correlation-id

string

A UUID value to track the request, used for debugging and tracing.

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 users of the group.

400The HTTP status code 400 Bad Request error, thrown when invalid parameters are passed

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.