Skip to content

Google: Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). For more information, see [Synchronize clients with Gmail](https://developers.google.com/workspace/gmail/api/guides/sync).: response body, field history / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item

FieldTypePresenceDescription and constraints
$objectRootA record of a change to the user’s mailbox. Each history change may affect multiple messages in multiple ways.
idstringOptionalThe mailbox sequence ID.
Format: uint64
labelsAddedarrayOptionalLabels added to messages in this history record.
labelsAdded[]ModelEach itemExpand Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item labels Added item
labelsRemovedarrayOptionalLabels removed from messages in this history record.
labelsRemoved[]ModelEach itemExpand Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item labels Removed item
messagesarrayOptionalList of messages changed in this history record. The fields for specific change types, such as `messagesAdded` may duplicate messages in this field. We recommend using the specific change-type fields instead of this.
messages[]ModelEach itemExpand Gets the specified message — response body
messagesAddedarrayOptionalMessages added to the mailbox in this history record.
messagesAdded[]ModelEach itemExpand Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item messages Added item
messagesDeletedarrayOptionalMessages deleted (not Trashed) from the mailbox in this history record.
messagesDeleted[]ModelEach itemExpand Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item messages Added item

Referenced models: Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item labels Added item, Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item labels Removed item, Lists the history of all changes to the given mailbox History results are returned in chronological order (increasing `history Id`) For more information, see Synchronize clients with Gmail (https: developers google com workspace gmail api guides sync) — response body — history item messages Added item, Gets the specified message — response body

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.