Return all Threads
GET {{baseUrl}}/v3/grants/:grant_id/threads?limit=20
Returns all threads. Not available for IMAP.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | The 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_token | string | An 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. | |
subject | string | Return threads with a matching literal subject. | |
any_email | string | Return 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. | |
to | string | Return threads containing messages sent to this email address. | |
from | string | Return threads containing messages sent from this email address. | |
cc | string | Return threads containing messages that were CC'd to this email address. | |
bcc | string | Return threads containing messages that were BCC'd to this email address, likely sent from the parent account. (Most SMTP gateways remove BCC information.) | |
in | string | Return threads with messages that belong to a specified folder. This parameter supports filtering by the ID of a folder. | |
unread | string | Return threads with one or more unread messages. | |
starred | string | Return threads with one or more starred messages. | |
latest_message_before | string | Return threads whose most recent message was received before this Unix timestamp. | |
latest_message_after | string | Return threads whose most recent message was received after this Unix timestamp. | |
has_attachment | string | Return threads with attachments. | |
search_query_native | string | The 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
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"value":"\u003cError: Could not resolve allOf schema"}