List email threads from the mailbox
GET {{baseUrl}}/emails/mailboxes/:email/threads?includeSpamTrash=false&labelIds=<string>&maxResults=<string>&pageToken=<string>&q=<string>
Lists the threads in the mailbox.
Scopes:
mail:read
Rate Limit Label
:
MEDIUM
Not supported in Gov cluster
Request Params
| Key | Datatype | Required | Description |
| includeSpamTrash | boolean | | Whether or not to include threads from SPAM and TRASH folders in the results. |
| labelIds | string | | Only return threads with message labels that match all of the specified label IDs in this query parameter. |
| maxResults | string | | Maximum number of threads to return. It defaults to 50. The maximum allowed value for this parameter is 500. |
| pageToken | string | | Page token to retrieve a specific page of results in the list. |
| q | string | | Only return threads matching the specified elastic search query. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"threads":[{"id":"\u003cstring\u003e","snippet":"\u003cstring\u003e","historyId":"\u003cstring\u003e","threadName":"\u003cstring\u003e","status":"normal"},{"id":"\u003cstring\u003e","snippet":"\u003cstring\u003e","historyId":"\u003cstring\u003e","threadName":"\u003cstring\u003e","status":"normal"}],"nextPageToken":"\u003cstring\u003e","resultSizeEstimate":"\u003cinteger\u003e"}