Skip to main content

List Spaces

Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent.

External Documentation

To learn more, visit the Google Chat documentation.

Basic Parameters

ParameterDescription
FilterA query filter. You can filter spaces by the space type
To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the spaceType can't be SPACE_TYPE_UNSPECIFIED).
To query for multiple space types, use the OR operator.

For example:
spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
Page SizeThe maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned.
The maximum value is 1,000. If you use a value more than 1,000, it's automatically changed to 1,000.
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.

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.

Example Output

{
"spaces": [
{
"name": "spaces/AAAASi2zNlU",
"type": "ROOM",
"displayName": "test",
"spaceThreadingState": "THREADED_MESSAGES",
"spaceType": "SPACE",
"spaceHistoryState": "HISTORY_ON"
},
{
"name": "spaces/-NHMRUAAAAE",
"type": "ROOM",
"spaceThreadingState": "UNTHREADED_MESSAGES",
"spaceType": "DIRECT_MESSAGE",
"spaceHistoryState": "HISTORY_ON"
}
]
}

Workflow Library Example

List Spaces with Google Chat and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop