List Threads
Retrieve the threads in one folder of an inbox.
GET
A thread is a conversation within an inbox, made up of one or more messages.
Path Parameters
Query Parameters
string
default:"inbox"
The folder to list:
inbox, archive, spam, sent, or trash.string
Case-insensitive substring matched against the thread subject and its label
names. Max length is
256 characters.string[]
Label IDs to filter by.
number
Number of threads to return. Default is
20, maximum is 100, minimum is
1.string
The ID of the last thread on the current page. Returns the next, older page.
string
The ID of the first thread on the current page. Returns the previous, newer
page.
Folders
Every thread sits in exactly one folder within its inbox.
You can move a thread to
inbox, archive, spam, or trash. sent is
assigned automatically.
Response Fields
string
Always
list.boolean
Whether more threads exist beyond this page. Pass the last thread’s
id as
after to continue.array
The threads in the folder, most recently active first.