gmail.users.threads.list
GET {{baseUrl}}/gmail/v1/users/:userId/threads?includeSpamTrash=<boolean>&labelIds=<string>&labelIds=<string>&maxResults=<integer>&pageToken=<string>&q=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists the threads in the user's mailbox.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
includeSpamTrash | string | Include threads from SPAM and TRASH in the results. | |
labelIds | string | Only return threads with labels that match all of the specified label IDs. | |
labelIds | string | Only return threads with labels that match all of the specified label IDs. | |
maxResults | string | Maximum number of threads to return. | |
pageToken | string | Page token to retrieve a specific page of results in the list. | |
q | string | Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"nextPageToken":"anim dolore dolore aliquip pariatur","resultSizeEstimate":-21814645,"threads":[{"historyId":"Ut ame","id":"sunt in elit dolor","messages":[{"historyId":"\u003cstring\u003e","id":"\u003cstring\u003e","internalDate":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"et Excepteur","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"officia ut","partId":"irure","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"\u003cstring\u003e","sizeEstimate":"\u003cinteger\u003e","snippet":"\u003cstring\u003e","threadId":"\u003cstring\u003e"},{"historyId":"\u003cstring\u003e","id":"\u003cstring\u003e","internalDate":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"fugiat id eu ","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"exercitation ullamco","partId":"ut in consequat ut","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"\u003cstring\u003e","sizeEstimate":"\u003cinteger\u003e","snippet":"\u003cstring\u003e","threadId":"\u003cstring\u003e"}],"snippet":"irure ex"},{"historyId":"in labore ut Lorem","id":"do in ut","messages":[{"historyId":"\u003cstring\u003e","id":"\u003cstring\u003e","internalDate":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"aliquip mollit","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"nisi consequat amet","partId":"incididunt consequat sed consectetur","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"\u003cstring\u003e","sizeEstimate":"\u003cinteger\u003e","snippet":"\u003cstring\u003e","threadId":"\u003cstring\u003e"},{"historyId":"\u003cstring\u003e","id":"\u003cstring\u003e","internalDate":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"incididunt minim dolore occaec","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"aute culpa","partId":"nisi","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"\u003cstring\u003e","sizeEstimate":"\u003cinteger\u003e","snippet":"\u003cstring\u003e","threadId":"\u003cstring\u003e"}],"snippet":"eiusmod Ut id occaecat Duis"}]}