threads_list - Charter

GET

gmail_threads_list.py

from charter.packs import gmail

result = await gmail.threads_list.ainvoke({})

Requires https://www.googleapis.com/auth/gmail.modify. Pages by cursor: nextPageToken is sent back as pageToken. Costs 10 against the provider’s own quota.

Path parameters

Field	Type	Description
`userId`	`string`	The user’s email address. The special value ‘me’ can be used to indicate the authenticated user. defaults to `"me"`

Query parameters

Field	Type	Description
`maxResults`	`integer`	Maximum number of threads to return (default 100, max 500). ≥ 1; ≤ 500; defaults to `10`
`pageToken`	`string`	Page token to retrieve a specific page of results in the list.
`q`	`string`	Only return threads matching this Gmail search query string.
`labelIds`	`string`[]	Return only threads with all of these label IDs.
`includeSpamTrash`	`boolean`	Include threads from SPAM and TRASH in the results.