Skip to main content

List Members

Lists memberships in a space or chat.

External Documentation

To learn more, visit the Google Chat documentation.

Basic Parameters

ParameterDescription
ChatThe resource name of the chat.
Format: spaces/{space}.
FilterA query filter. You can filter memberships by a member's role (role) and type (member.type).

To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER.
To filter by type, set member.type to HUMAN or BOT.
To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator.

For example, the following queries are valid:
role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

The following queries are invalid:
member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
List FromFrom which type of space to list the members.
Page SizeThe maximum number of memberships to return. The service might return fewer than this value.
If unspecified, at most 100 memberships are returned.
The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000.
SpaceThe resource name of the space.
Format: spaces/{space}.

Advanced Parameters

ParameterDescription
Delegated User OverridePerform the action on behalf of another user, overriding the delegated user defined in the connection.

If not specified, the delegated user is the one provided in the connection.

Has no effect when using an OAuth connection.

NOTE: the connection details are not edited by this input.
Page TokenA page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.
When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

Example Output

{
"memberships": [
{
"name": "spaces/AAAFF75edfb4/members/42342978345091345",
"state": "JOINED",
"member": {
"name": "users/42342978345091345",
"type": "HUMAN"
},
"createTime": "2023-08-23T08:44:26.313840Z",
"role": "ROLE_MANAGER"
}
]
}

Workflow Library Example

List Members with Google Chat and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop