Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Gmail

Gmail is Google’s cloud based email service that allows you to access your messages from any computer or device with just a web browser.

Gmail logo

Supports authentication: OAuth 2.0

Fetch emails from a connected Gmail account using search filters. Requires a valid Gmail OAuth2 connection.

PropertiesDescriptionType
formatFormat of the returned message.string
include_spam_trashWhether to fetch emails from spam and trash foldersboolean
label_idsGmail label IDs to filter messagesarray<string>
max_resultsMaximum number of emails to fetchinteger
page_tokenPage token for paginationstring
querySearch query string using Gmail’s search syntax (e.g., ‘is:unread from:user@example.com’)string
schema_versionOptional schema version to use for tool executionstring
tool_versionOptional tool version to use for executionstring

Retrieve a specific attachment from a Gmail message using the message ID and attachment ID.

PropertiesDescriptionType
attachment_idUnique Gmail attachment IDstring
file_namePreferred filename to use when saving/returning the attachmentstring
message_idUnique Gmail message ID that contains the attachmentstring
schema_versionOptional schema version to use for tool executionstring
tool_versionOptional tool version to use for executionstring

Fetch a list of contacts from the connected Gmail account. Supports pagination and field filtering.

PropertiesDescriptionType
max_resultsMaximum number of contacts to fetchinteger
page_tokenToken to retrieve the next page of resultsstring
person_fieldsFields to include for each personarray<string>
schema_versionOptional schema version to use for tool executionstring
tool_versionOptional tool version to use for executionstring

Retrieve a specific Gmail message using its message ID. Optionally control the format of the returned data.

PropertiesDescriptionType
formatFormat of the returned message.string
message_idUnique Gmail message IDstring
schema_versionOptional schema version to use for tool executionstring
tool_versionOptional tool version to use for executionstring

List draft emails from a connected Gmail account. Requires a valid Gmail OAuth2 connection.

PropertiesDescriptionType
max_resultsMaximum number of drafts to fetchinteger
page_tokenPage token for paginationstring
schema_versionOptional schema version to use for tool executionstring
tool_versionOptional tool version to use for executionstring

Search people or contacts in the connected Google account using a query. Requires a valid Google OAuth2 connection with People API scopes.

PropertiesDescriptionType
other_contactsWhether to include people not in the user’s contacts (from ‘Other Contacts’).boolean
page_sizeMaximum number of people to return.integer
person_fieldsFields to retrieve for each person.array<string>
queryText query to search people (e.g., name, email address).string
schema_versionOptional schema version to use for tool executionstring
tool_versionOptional tool version to use for executionstring