List history of events for mailbox
GET {{baseUrl}}/emails/mailboxes/:email/history?maxResults=<integer>&pageToken=<string>&startHistoryId=<string>&historyTypes=delegateUpdated&excludeHistoryTypes=delegatorsUpdated&labelId=<string>
Lists the history of the changes to the given mailbox.
Scopes:
mail:read
Rate Limit Label
:
LIGHT
Not supported in Gov cluster
Request Params
| Key | Datatype | Required | Description |
| maxResults
| string | | Maximum number of history events to return. This field defaults to 50. The maximum allowed value is 500. |
| pageToken
| string | | The page token to retrieve a specific page of results in the list. |
| startHistoryId
| string | | (Required) Returns history records after the specified startHistoryId
. The supplied startHistoryId
should be obtained from the historyId
of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between. Supplying an invalid or out of date startHistoryId
typically returns an HTTP 404 error code. A historyId
is typically valid for at least a week, but in some rare circumstances may be valid for much shorter period. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId
for a future request. |
| historyTypes
| string | | History types to be returned by the function. If one history type included in both query parametershistoryType
and excludeHistoryType
, the exclude take the priority. |
| excludeHistoryTypes
| string | | History types not to be returned by the function. If one history type included in both query parameters historyTypes
and excludeHistoryTypes
, the exclude take the priority. |
| labelId
| string | | Only return messages with a label matching the ID. |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"history":[{"id":"\u003cstring\u003e","cid":"\u003cstring\u003e","messagesAdded":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesDeleted":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesImported":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesImportedNew":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesUpdated":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"labelsAdded":[{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"labelsRemoved":[{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"settingsAdded":[{"id":"\u003cstring\u003e","type":"signature"},{"id":"\u003cstring\u003e","type":"delegation"}],"settingsDeleted":[{"id":"\u003cstring\u003e","type":"emailTemplates"},{"id":"\u003cstring\u003e","type":"userLabels"}],"settingsUpdated":[{"id":"\u003cstring\u003e","type":"delegation"},{"id":"\u003cstring\u003e","type":"disposableEmails"}],"delegatesAdded":["\u003cstring\u003e","\u003cstring\u003e"],"delegatesDeleted":["\u003cstring\u003e","\u003cstring\u003e"],"delegatesUpdated":["\u003cstring\u003e","\u003cstring\u003e"],"delegatorsAdded":["\u003cstring\u003e","\u003cstring\u003e"],"delegatorsDeleted":["\u003cstring\u003e","\u003cstring\u003e"],"delegatorsUpdated":["\u003cstring\u003e","\u003cstring\u003e"]},{"id":"\u003cstring\u003e","cid":"\u003cstring\u003e","messagesAdded":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesDeleted":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesImported":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesImportedNew":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"messagesUpdated":[{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"labelsAdded":[{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"labelsRemoved":[{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}},{"labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"message":{"id":"\u003cstring\u003e","labelIds":["\u003cstring\u003e","\u003cstring\u003e"],"threadId":"\u003cstring\u003e"}}],"settingsAdded":[{"id":"\u003cstring\u003e","type":"filter"},{"id":"\u003cstring\u003e","type":"delegation"}],"settingsDeleted":[{"id":"\u003cstring\u003e","type":"signature"},{"id":"\u003cstring\u003e","type":"delegation"}],"settingsUpdated":[{"id":"\u003cstring\u003e","type":"language"},{"id":"\u003cstring\u003e","type":"filter"}],"delegatesAdded":["\u003cstring\u003e","\u003cstring\u003e"],"delegatesDeleted":["\u003cstring\u003e","\u003cstring\u003e"],"delegatesUpdated":["\u003cstring\u003e","\u003cstring\u003e"],"delegatorsAdded":["\u003cstring\u003e","\u003cstring\u003e"],"delegatorsDeleted":["\u003cstring\u003e","\u003cstring\u003e"],"delegatorsUpdated":["\u003cstring\u003e","\u003cstring\u003e"]}],"nextPageToken":"\u003cstring\u003e","historyId":"\u003cstring\u003e"}