/gmail/v1/users/{userId}/history

GET/gmail/v1/users/{userId}/history

Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId).

Request

Path Params

userId

string

required

The user's email address. The special value me can be used to indicate the authenticated user.

Query Params

historyTypes

array[string]

optional

History types to be returned by the function

labelId

string

optional

Only return messages with a label matching the ID.

maxResults

integer

optional

Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.

pageToken

string

optional

Page token to retrieve a specific page of results in the list.

startHistoryId

string

optional

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 valid IDs. 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 only a few hours. 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.

Request samples

Responses

Successful response(200)

Successful response

HTTP Code: 200

Content Type : JSONapplication/json

No schema defined

Not configured

Last modified: a year ago