Method: spaces.messages.list

Stay organized with collections Save and categorize content based on your preferences.

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. Requires user authentication and the chat.messages or chat.messages.readonly authorization scope.

HTTP request

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the space to list messages from.

Format: spaces/{space}

Query parameters

Parameters
pageSize

integer

The maximum number of messages returned. The service may return fewer messages than this value.

If unspecified, at most 25 are returned.

The maximum value is 1000; values above 1000 are coerced to 1000.

Negative values return an INVALID_ARGUMENT error.

pageToken

string

Optional, if resuming from a previous query.

A page token received from a previous list messages call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters may lead to unexpected results.

filter

string

A query filter.

The API supports filtering by createTime and thread.name.

For example, the following queries are valid:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND
createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

Note that the createTime timestamp must be enclosed in double-quotes.

At most 1 thread is supported in the query.

Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

orderBy

string

Optional, if resuming from a previous query.

How the list of messages is ordered. Specify a value to order by and an ordering operation. Valid ordering operation values are:

  • ASC for ascending.

  • DESC for descending.

The default ordering is createTime ASC.

The supported syntax is:

createTime ASC

showDeleted

boolean

Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Fields
messages[]

object (Message)

List of messages.

nextPageToken

string

A token that can be sent as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

For more information, see the OAuth 2.0 Overview.