List Threads

GET {{baseUrl}}/gmail/v1/users/:userId/threads

Lists the threads in the user's mailbox.

Request Params

KeyDatatypeRequiredDescription
maxResultsstring
pageTokenstring
qstring
labelIdsstring
includeSpamTrashstring
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI 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_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable 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_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").
$.xgafvstringV1 error format.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"threads":[{"id":"commodo","snippet":"eiusmod consequat qui non quis","historyId":"sunt dolore","messages":[{"id":"enim","threadId":"dolore quis exercitation","labelIds":["Duis sint dolore","in labore ut commodo"],"snippet":"nostrud dolore consectetur Excepteur","historyId":"ea elit consectet","internalDate":"proident ullamco","payload":{"partId":"consectetur pariatur dolore","mimeType":"ad occaecat culpa ullamco","filename":"officia elit","headers":[{"name":"co","value":"deserunt ut"},{"name":"do","value":"ea dolor"}],"body":{"attachmentId":"quis elit commodo","size":44099715,"data":"irure dolore ut"},"parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"sizeEstimate":21887814,"raw":"nulla ipsum Ut"},{"id":"in dolor proident","threadId":"dolore culpa fugiat","labelIds":["in ut amet","Ut sit dolor ut"],"snippet":"nisi Duis deserunt labore","historyId":"sunt pariatur elit laboris ex","internalDate":"esse pariatur","payload":{"partId":"laboris nulla et","mimeType":"dolore ullamco consectetur nostrud","filename":"aliqua commodo","headers":[{"name":"Ut","value":"laborum"},{"name":"consequat","value":"esse"}],"body":{"attachmentId":"qui consequat minim","size":83387838,"data":"id"},"parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"sizeEstimate":70145632,"raw":"cillum in ipsum ex"}]},{"id":"qui ipsum veniam irure fugiat","snippet":"elit occaecat magna","historyId":"mollit","messages":[{"id":"laborum et","threadId":"elit sint quis","labelIds":["sunt amet aute dolore fugiat","Ut aliqua"],"snippet":"do magna","historyId":"aliqua enim labore","internalDate":"laboris tempor anim voluptate","payload":{"partId":"aute Ut nisi eiusmod","mimeType":"non deserunt anim","filename":"magna","headers":[{"name":"est sunt fugiat","value":"deserunt exer"},{"name":"consectetur anim","value":"laborum elit"}],"body":{"attachmentId":"dolor id esse proident","size":-31164209,"data":"irure consectetur"},"parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"sizeEstimate":-76389446,"raw":"nulla dolor nisi reprehenderit sint"},{"id":"ea laborum sint","threadId":"laboris magna","labelIds":["velit ","ad sint sunt ex n"],"snippet":"ea in magna ve","historyId":"sit tempor","internalDate":"qui laborum","payload":{"partId":"aute dolore deserunt do veniam","mimeType":"voluptate ut ad irure est","filename":"nostrud Lorem aliquip elit anim","headers":[{"name":"voluptate sed","value":"in ullamco consequat"},{"name":"ullamco","value":"ex"}],"body":{"attachmentId":"elit eiusmod sint","size":93740460,"data":"in non nulla anim"},"parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"sizeEstimate":76344706,"raw":"nisi nostrud"}]}],"nextPageToken":"Exce","resultSizeEstimate":-82340850}