Gmail API
  • users
    • /gmail/v1/users/{userId}/draftsGET
    • /gmail/v1/users/{userId}/draftsPOST
    • /gmail/v1/users/{userId}/drafts/sendPOST
    • /gmail/v1/users/{userId}/drafts/{id}DELETE
    • /gmail/v1/users/{userId}/drafts/{id}GET
    • /gmail/v1/users/{userId}/drafts/{id}PUT
    • /gmail/v1/users/{userId}/historyGET
    • /gmail/v1/users/{userId}/labelsGET
    • /gmail/v1/users/{userId}/labelsPOST
    • /gmail/v1/users/{userId}/labels/{id}DELETE
    • /gmail/v1/users/{userId}/labels/{id}GET
    • /gmail/v1/users/{userId}/labels/{id}PATCH
    • /gmail/v1/users/{userId}/labels/{id}PUT
    • /gmail/v1/users/{userId}/messagesGET
    • /gmail/v1/users/{userId}/messagesPOST
    • /gmail/v1/users/{userId}/messages/batchDeletePOST
    • /gmail/v1/users/{userId}/messages/batchModifyPOST
    • /gmail/v1/users/{userId}/messages/importPOST
    • /gmail/v1/users/{userId}/messages/sendPOST
    • /gmail/v1/users/{userId}/messages/{id}DELETE
    • /gmail/v1/users/{userId}/messages/{id}GET
    • /gmail/v1/users/{userId}/messages/{id}/modifyPOST
    • /gmail/v1/users/{userId}/messages/{id}/trashPOST
    • /gmail/v1/users/{userId}/messages/{id}/untrashPOST
    • /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}GET
    • /gmail/v1/users/{userId}/profileGET
    • /gmail/v1/users/{userId}/settings/autoForwardingGET
    • /gmail/v1/users/{userId}/settings/autoForwardingPUT
    • /gmail/v1/users/{userId}/settings/cse/identitiesGET
    • /gmail/v1/users/{userId}/settings/cse/identitiesPOST
    • /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}DELETE
    • /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}GET
    • /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}PATCH
    • /gmail/v1/users/{userId}/settings/cse/keypairsGET
    • /gmail/v1/users/{userId}/settings/cse/keypairsPOST
    • /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}GET
    • /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disablePOST
    • /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enablePOST
    • /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliteratePOST
    • /gmail/v1/users/{userId}/settings/delegatesGET
    • /gmail/v1/users/{userId}/settings/delegatesPOST
    • /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}DELETE
    • /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}GET
    • /gmail/v1/users/{userId}/settings/filtersGET
    • /gmail/v1/users/{userId}/settings/filtersPOST
    • /gmail/v1/users/{userId}/settings/filters/{id}DELETE
    • /gmail/v1/users/{userId}/settings/filters/{id}GET
    • /gmail/v1/users/{userId}/settings/forwardingAddressesGET
    • /gmail/v1/users/{userId}/settings/forwardingAddressesPOST
    • /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}DELETE
    • /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}GET
    • /gmail/v1/users/{userId}/settings/imapGET
    • /gmail/v1/users/{userId}/settings/imapPUT
    • /gmail/v1/users/{userId}/settings/languageGET
    • /gmail/v1/users/{userId}/settings/languagePUT
    • /gmail/v1/users/{userId}/settings/popGET
    • /gmail/v1/users/{userId}/settings/popPUT
    • /gmail/v1/users/{userId}/settings/sendAsGET
    • /gmail/v1/users/{userId}/settings/sendAsPOST
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}DELETE
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}GET
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}PATCH
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}PUT
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfoGET
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfoPOST
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}DELETE
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}GET
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefaultPOST
    • /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verifyPOST
    • /gmail/v1/users/{userId}/settings/vacationGET
    • /gmail/v1/users/{userId}/settings/vacationPUT
    • /gmail/v1/users/{userId}/stopPOST
    • /gmail/v1/users/{userId}/threadsGET
    • /gmail/v1/users/{userId}/threads/{id}DELETE
    • /gmail/v1/users/{userId}/threads/{id}GET
    • /gmail/v1/users/{userId}/threads/{id}/modifyPOST
    • /gmail/v1/users/{userId}/threads/{id}/trashPOST
    • /gmail/v1/users/{userId}/threads/{id}/untrashPOST
    • /gmail/v1/users/{userId}/watchPOST
logoPowered by Apidog

    /gmail/v1/users/{userId}/messages

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

    Lists the messages in the user's mailbox.

    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
    includeSpamTrash
    string 
    optional

    Include messages from SPAM and TRASH in the results.

    labelIds
    array[string]
    optional

    Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don't have. To learn more, see Manage labels on messages and threads.

    maxResults
    integer 
    optional

    Maximum number of messages 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.

    q
    string 
    optional

    Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.

    Request samples

    Responses

    Successful response(200)
    Successful response
    HTTP Code: 200
    Content Type : JSONapplication/json
    Data Schema
    No schema defined
    Example
    Not configured
    Last modified: a year ago
    Previous
    PUT/gmail/v1/users/{userId}/labels/{id}
    Next
    POST/gmail/v1/users/{userId}/messages