Return all Messages
GET {{baseUrl}}/v3/grants/:grant_id/messages?limit=50
Returns all messages.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | The number of objects to return. This field defaults to 50. The maximum allowed value for this field is 200. 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 items with a matching literal subject. | |
any_email | string | Return emails that have been sent or received from this comma-separated list of email addresses. For example: mail1@example.com,mail2@example.com. A maximum of 25 emails may be specified. | |
to | string | Return items containing messages sent to this email address. | |
from | string | Return items containing messages sent from this email address. | |
cc | string | Return items containing messages that were CC'd to this email address. | |
bcc | string | Return items 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 messages that are in a specific folder. Specify which folder by including the folder ID. In API v3, use the Folders API for both folders and Gmail's "lablels". | |
unread | string | Return items with one or more unread messages. | |
starred | string | Return items with one or more starred messages. | |
thread_id | string | Return items with a matching thread_id. | |
received_before | string | Return messages received before this Unix timestamp. | |
received_after | string | Return messages received after this Unix timestamp. | |
has_attachment | string | Return messages with attachments. | |
fields | string | Return messages with headers by specifying "include_headers". | |
search_query_native | string | The provider-specific query string used to search messages. Available for Google and Microsoft Graph only. If you include a search_query_native parameter, you can only use a few specific query parameters with it. For Microsoft this is limit and page_token , and for Google you can use limit , page_token and thread_id . A search_query_native 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"}