List Folders

Returns all folders in a connected mailbox.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
ℹ️

Pagination behavior

  • Default pageSize is 10
  • For fetching next set of records always use pageToken
  • Filters applied in initial request are honored, so keep filters same for subsequent request
  • Google doesn't support pagination in the API
ℹ️

Folder hierarchy (Outlook Mail only)

  • By default, only top level folders are listed
  • Top level folders have parentId = root
  • To list children folders, include the parent folder ID in the request
  • Folder hierarchy and parent-child relationship is only supported in Outlook Mail

Supported Apps

Here is the list of apps that supports this API

Google Mail (google-mail)

Flat folder structure only

Outlook Mail (outlook-mail)

Supports hierarchical folder structure

Query Params
int32
string
Defaults to null
string

Use the ID of a folder to find all child folders it contains.

boolean
Defaults to false

If true, retrieves folders from a single-level hierarchy only. If false, retrieves folders across a multi-level hierarchy.

boolean
Defaults to false

If true, we will include origin API response in the return. Default value is false

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json