Method: users.sections.list

Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. 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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following:

  • The me alias. For example, users/me.

  • Their Workspace email address. For example, users/user@example.com.

  • Their user id. For example, users/123456789.

Format: users/{user}

Query parameters

Parameters
pageSize

integer

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

If unspecified, at most 10 sections 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 sections 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.

Request body

The request body must be empty.

Response body

Response message for listing sections.

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

JSON representation 
{
  "sections": [
    {
      object (Section)
    }
  ],
  "nextPageToken": string
}
Fields
sections[]

object (Section)

The sections from the specified user.
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.