gmail.users.history.list

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

Copy endpoint

https://gmail.googleapis.com/

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

Parameters

path Path Parameters

Name	Type
`userId` required The user's email address. The special value `me` can be used to indicate the authenticated user.	string

query Query Parameters

Name	Type
`historyTypes` History types to be returned by the function	("messageAdded" \| "messageDeleted" \| "labelAdded" \| "labelRemoved")[]
`labelId` Only return messages with a label matching the ID.	string
`maxResults` Maximum number of history records to return. This field defaults to 100. The maximum allowed value for this field is 500.	number
`pageToken` Page token to retrieve a specific page of results in the list.	string
`startHistoryId` 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.	string
`fields` Selector specifying which fields to include in a partial response.	string
`upload_protocol` Upload protocol for media (e.g. "raw", "multipart").	string
`uploadType` Legacy upload protocol for media (e.g. "media", "multipart").	string
`$.xgafv` V1 error format.	"1" \| "2"
`oauth_token` OAuth 2.0 token for the current user.	string
`prettyPrint` Returns response with indentations and line breaks.	boolean
`quotaUser` Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.	string
`access_token` OAuth access token.	string
`callback` JSONP	string
`key` API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.	string
`alt` Data format for response.	"json" \| "media" \| "proto"

Responses

200 */*

Successful response

interface ListHistoryResponse {
history?:

History

A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.

interface History {
id?: string;
labelsAdded?: HistoryLabelAdded[];
labelsRemoved?: HistoryLabelRemoved[];
messages?: Message[];
messagesAdded?: HistoryMessageAdded[];
messagesDeleted?: HistoryMessageDeleted[];
}

[];
historyId?: string;
nextPageToken?: string;
}