Method: users.sections.items.list

Lists items in a section.

Currently, only spaces can be section items. For details, see Create & organize sections in Google Chat.

Requires user authentication with the authorization scope:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

HTTP request

GET https://chat.googleapis.com/v1/{parent=users/*/sections/*}/items

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user.

Format: users/{user}/sections/{section}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of section items to return. The service may return fewer than this value.

If unspecified, at most 10 section items will be returned.

The maximum value is 100. If you use a value more than 100, it's automatically changed to 100.

Negative values return an INVALID_ARGUMENT error.

pageToken

string

Optional. A page token, received from a previous list section items 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 might lead to unexpected results.

filter

string

Optional. A query filter.

Currently only supports filtering by space.

For example, space = spaces/{space}.

Invalid queries are rejected with an INVALID_ARGUMENT error.

Request body

The request body must be empty.

Response body

Response message for listing section items.

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

JSON representation
{
  "sectionItems": [
    {
      object (SectionItem)
    }
  ],
  "nextPageToken": string
}
Fields
sectionItems[]

object (SectionItem)

The section items from the specified section.

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

For more information, see the Authorization guide.