• management
• SDK
• MembersClient

Class MembersClient

Index

Constructors

constructor

Methods

get

Properties

_options

Constructors

constructor

new MembersClient(options: BaseClientOptions): MembersClient

Parameters

• options: BaseClientOptions

Returns MembersClient

Methods

get

get(
id: string,
request?: GetGroupMembersRequestParameters,
requestOptions?: MembersClient.RequestOptions,
): Promise<Page<GroupMember, GetGroupMembersResponseContent>>

List all users that are a member of this group.

Parameters

• id: string

Unique identifier for the group (service-generated).

• request: GetGroupMembersRequestParameters = {}
• OptionalrequestOptions: MembersClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<GroupMember, GetGroupMembersResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.groups.members.get("id", { fields: "fields", include_fields: true, from: "from", take: 1 })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods get Properties _options