younifyd
Menu

Gmail.users.drafts.list

Lists the drafts in the user's mailbox.

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

Use it in a workflow

  1. Add a step and choose the Gmail connector.
  2. Pick the Gmail.users.drafts.list action (under users).
  3. Fill in the fields below, then reference the result from later steps as {{gmailUsersDraftsList.response.data}}.

Request

Path parameters

userIdstringrequired

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

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

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").

includeSpamTrashboolean

Include drafts from `SPAM` and `TRASH` in the results.

maxResultsinteger

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

qstring

Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.

Response

Returns 200 with an object. Read it in later steps with {{gmailUsersDraftsList.response.data.<field>}}.

draftsarray<object>

List of drafts. Note that the `Message` property in each `Draft` resource only contains an `id` and a `threadId`. The messages.get method can fetch additional message details.

idstring

The immutable ID of the draft.

messageobject9 fields

An email message.

nextPageTokenstring

Token to retrieve the next page of results in the list.

resultSizeEstimateinteger (uint32)

Estimated total number of results.

json
{
  "drafts": [
    {
      "id": "string",
      "message": {
        "historyId": "string",
        "id": "string",
        "internalDate": "string",
        "labelIds": [
          "string"
        ],
        "payload": {
          "body": {
            "attachmentId": "string",
            "data": "string",
            "size": 0
          },
          "filename": "string",
          "headers": [
            {
              "name": null,
              "value": null
            }
          ],
          "mimeType": "string",
          "partId": "string",
          "parts": [
            {}
          ]
        },
        "raw": "string",
        "sizeEstimate": 0,
        "snippet": "string",
        "threadId": "string"
      }
    }
  ],
  "nextPageToken": "string",
  "resultSizeEstimate": 0
}

Need more? See the Gmail guide for connection setup and behaviour shared by every action.