Return all Threads

GET {{baseUrl}}/v3/grants/:grant_id/threads?limit=20

Returns all threads. Not available for IMAP.

Request Params

KeyDatatypeRequiredDescription
limitnumberThe number of objects to return. This field defaults to 20. The maximum allowed value for this field is 50. See pagination for more information.
page_tokenstringAn identifier that specifies which page of data to return. This value should be taken from the next_cursor response field. See pagination for more information.
subjectstringReturn threads with a matching literal subject.
any_emailstringReturn threads that contain messages that have been sent or received from this comma-separated list of email addresses. A maximum of 25 emails may be specified.
tostringReturn threads containing messages sent to this email address.
fromstringReturn threads containing messages sent from this email address.
ccstringReturn threads containing messages that were CC'd to this email address.
bccstringReturn threads containing messages that were BCC'd to this email address, likely sent from the parent account. (Most SMTP gateways remove BCC information.)
instringReturn threads with messages that belong to a specified folder. This parameter supports filtering by the ID of a folder.
unreadstringReturn threads with one or more unread messages.
starredstringReturn threads with one or more starred messages.
latest_message_beforestringReturn threads whose most recent message was received before this Unix timestamp.
latest_message_afterstringReturn threads whose most recent message was received after this Unix timestamp.
has_attachmentstringReturn threads with attachments.
search_query_nativestringThe provider-specific query string used to search threads. Available for Google and Microsoft Graph only. If specified, the search_query_native parameter can only be used with pagination parameters (limit and page_token). A value example for Google would be subject:foo OR subject:bar.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"value":"\u003cError: Could not resolve allOf schema"}