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: Rate Limit Label: Not supported in Gov cluster mail:read
LIGHT
Body
PARAM
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 parameters``historyType`` 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
Curl curl -X GET 'https://api.zoom.us/v2/emails/mailboxes/:email/history?maxResults=<integer>&pageToken=<string>&startHistoryId=<string>&historyTypes=delegateUpdated&excludeHistoryTypes=delegatorsUpdated&labelId=<string>?maxResults=<integer>&pageToken=<string>&startHistoryId=<string>&historyTypes=delegateUpdated&excludeHistoryTypes=delegatorsUpdated&labelId=<string>' -H 'Accept: application/json' ENDPOINTS |