v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-173225164.2 KB
users

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

get/users/{userId}/history

Path parameters

userIdstring required

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

Query parameters

$.xgafv'1' | '2'

V1 error format

V1 error format

access_tokenstring

OAuth access token

alt'json' | 'media' | 'proto'

Data format for response

Data format for response

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response

keystring

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

oauth_tokenstring

OAuth 2.0 token for the current user

prettyPrintboolean

Returns response with indentations and line breaks

quotaUserstring

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

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart")

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart")

historyTypesstring[]

History types to be returned by the function

labelIdstring

Only return messages with a label matching the ID

maxResultsinteger

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

pageTokenstring

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

startHistoryIdstring

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

Response

Successful response

historyIdstring uint64

The ID of the mailbox's current history record

nextPageTokenstring

Page token to retrieve the next page of results in the list