Skip to main content

Docs

The tool catalog

This page lists the toolkits of SambungAPI, the tools of each toolkit, and the arguments that each tool takes. Read it to plan a call before you sign up.

On this page

A project key is the credential your software uses to run tools for one project. A tool executes with a project key, against a connected account of its toolkit: The SambungAPI API shows the call and its envelope.

The toolkits

ToolkitOfferedConnectsTools
GmailOfferedOne account for each application user5
Google CalendarOfferedOne account for each application user5
Google SheetsOfferedOne account for each application user9
Google DriveOfferedOne account for each application user10
Google DocsOfferedOne account for each application user4
Google SlidesOfferedOne account for each application user4
Google MeetOfferedOne account for each application user2
Google SuperOfferedOne account for each application user0
OutlookNot offeredOne account for each application user3
OneDriveNot offeredOne account for each application user7
GitHubNot offeredOne account for each application user4
NotionNot offeredOne account for each application user4
LinearNot offeredOne account for each application user13
JiraNot offeredOne account for each application user3

Gmail

Fetch Emails

GMAIL_FETCH_EMAILS

Fetch emails from the connected Gmail account, optionally filtered by a query.

Arguments

ArgumentTypeRequiredDescription
max_resultsnumberNoMaximum number of emails to return. Default: 10.
querystringNoGmail search query (e.g. 'from:alice is:unread')

Fetch Message by ID

GMAIL_FETCH_MESSAGE_BY_MESSAGE_ID

Fetch a single Gmail message by its message id.

Arguments

ArgumentTypeRequiredDescription
formatstring, one of full, metadata, minimal, rawNoMessage format. Default: full.
message_idstringYesGmail message id

Get Attachment

GMAIL_GET_ATTACHMENT

Fetch a Gmail message attachment by message id and attachment id.

Arguments

ArgumentTypeRequiredDescription
attachment_idstringYesAttachment id
message_idstringYesGmail message id

Send Email

GMAIL_SEND_EMAIL

Send an email from the connected Gmail account.

Arguments

ArgumentTypeRequiredDescription
bodystringYesEmail body
extra_recipientsarray of stringNoAdditional recipient email addresses
is_htmlbooleanNoWhether the body is HTML. Default: false.
recipient_emailstringYesRecipient email address
subjectstringYesEmail subject

Modify Email Labels

GMAIL_ADD_LABEL_TO_EMAIL

Add labels to one Gmail message, remove labels from it, or both. System label ids work as they are: UNREAD, STARRED, IMPORTANT, INBOX, SPAM, TRASH and CATEGORY_*. Mark a message read: remove UNREAD. Star it: add STARRED. Archive it: remove INBOX. Needs the gmail.modify scope (https://www.googleapis.com/auth/gmail.modify).

Arguments

ArgumentTypeRequiredDescription
add_label_idsarray of stringNoLabel ids to add, for example ["STARRED"]
message_idstringYesGmail message id
remove_label_idsarray of stringNoLabel ids to remove, for example ["UNREAD"] to mark the message read
user_idstringNoThe Gmail user: me for the connected account, or its email address. Not the user_id of the execute body. Default: me.

Google Calendar

Find Event

GOOGLECALENDAR_FIND_EVENT

Find events on a Google Calendar within an optional time range.

Arguments

ArgumentTypeRequiredDescription
calendar_idstringYesCalendar id. Default: primary.
max_resultsnumberYesMaximum number of events to return. Default: 100.
order_bystring, one of startTime, updatedYesOrder of the results
page_tokenstringNoPagination token
qstringNoFree-text search query
single_eventsbooleanYesExpand recurring events into single instances. Default: true.
time_maxstringYesEnd of the query window (RFC3339)
time_minstringYesStart of the query window (RFC3339)

Create Event

GOOGLECALENDAR_CREATE_EVENT

Create a new event on a Google Calendar.

Arguments

ArgumentTypeRequiredDescription
attendeesarray of stringNoAttendee email addresses
calendar_idstringNoCalendar id. Default: primary.
create_meeting_roombooleanNoAttach a Google Meet conference. Default: false.
descriptionstringNoEvent description
end_datetimestringYesEnd date-time (RFC3339)
locationstringNoEvent location
start_datetimestringYesStart date-time (RFC3339)
summarystringYesEvent title
timezonestringNoIANA timezone for the event

Patch Event

GOOGLECALENDAR_PATCH_EVENT

Update fields of an existing Google Calendar event.

Arguments

ArgumentTypeRequiredDescription
attendeesarray of stringNoAttendee email addresses
calendar_idstringNoCalendar id. Default: primary.
descriptionstringNoNew event description
end_datetimestringNoNew end date-time (RFC3339)
event_idstringYesEvent id
locationstringNoNew event location
start_datetimestringNoNew start date-time (RFC3339)
summarystringNoNew event title

Delete Event

GOOGLECALENDAR_DELETE_EVENT

Delete a Google Calendar event by id.

Arguments

ArgumentTypeRequiredDescription
calendar_idstringNoCalendar id. Default: primary.
event_idstringYesEvent id

Find Free Slots

GOOGLECALENDAR_FIND_FREE_SLOTS

Find free time slots across one or more calendars in a time window.

Arguments

ArgumentTypeRequiredDescription
itemsarray of stringYesCalendar ids to check
time_maxstringYesEnd of the window (RFC3339)
time_minstringYesStart of the window (RFC3339)
timezonestringNoIANA timezone

Google Sheets

Batch Get Values

GOOGLESHEETS_BATCH_GET

Read values from multiple ranges of a Google Spreadsheet.

Arguments

ArgumentTypeRequiredDescription
rangesarray of stringYesA1 ranges to read
spreadsheet_idstringYesSpreadsheet id

Update Values

GOOGLESHEETS_VALUES_UPDATE

Write values into a range of a Google Spreadsheet.

Arguments

ArgumentTypeRequiredDescription
rangestringYesA1 range to write
spreadsheet_idstringYesSpreadsheet id
value_input_optionstring, one of USER_ENTERED, RAWYesHow input should be interpreted. Default: USER_ENTERED.
valuesarray of arrayYesRows of values

Append Values

GOOGLESHEETS_SPREADSHEETS_VALUES_APPEND

Append rows of values to a range of a Google Spreadsheet.

Arguments

ArgumentTypeRequiredDescription
rangestringYesA1 range to append after
spreadsheetIdstringYesSpreadsheet id
valueInputOptionstring, one of USER_ENTERED, RAWNoHow input should be interpreted. Default: USER_ENTERED.
valuesarray of arrayYesRows of values

Sort Range

GOOGLESHEETS_SORT_RANGE

Sort a range of a Google Spreadsheet by a sort specification.

Arguments

ArgumentTypeRequiredDescription
rangeobjectYesGridRange to sort
sortSpecobjectNoSortSpec (dimensionIndex, sortOrder)
spreadsheet_idstringYesSpreadsheet id

Add Sheet

GOOGLESHEETS_ADD_SHEET

Add a new sheet (tab) to a Google Spreadsheet.

Arguments

ArgumentTypeRequiredDescription
spreadsheet_idstringYesSpreadsheet id
titlestringYesTitle of the new sheet

Batch Update

GOOGLESHEETS_BATCH_UPDATE

Write a batch of values into a sheet starting at a cell location.

Arguments

ArgumentTypeRequiredDescription
first_cell_locationstringNoStarting cell (e.g. A1). Default: A1.
sheet_namestringYesName of the sheet to write into
spreadsheet_idstringYesSpreadsheet id
value_input_optionstring, one of USER_ENTERED, RAWNoHow input should be interpreted. Default: USER_ENTERED.
valuesarray of arrayYesRows of values

Get Sheet Names

GOOGLESHEETS_GET_SHEET_NAMES

List the names of all sheets in a Google Spreadsheet.

Arguments

ArgumentTypeRequiredDescription
spreadsheet_idstringYesSpreadsheet id

Get Batch Values

GOOGLESHEETS_GET_BATCH_VALUES

Read values from multiple ranges of a Google Spreadsheet.

Arguments

ArgumentTypeRequiredDescription
rangesarray of stringYesA1 ranges to read
spreadsheet_idstringYesSpreadsheet id

Create Google Sheet

GOOGLESHEETS_CREATE_GOOGLE_SHEET1

Create a new Google Spreadsheet with an optional title.

Arguments

ArgumentTypeRequiredDescription
textstringNoOptional initial text content
titlestringNoTitle of the new spreadsheet

Google Drive

Find File

GOOGLEDRIVE_FIND_FILE

Search for files in Google Drive by query or folder.

Arguments

ArgumentTypeRequiredDescription
folder_idstringNoRestrict results to this folder
pageSizenumberNoMax results. Default: 10.
qstringNoDrive search query

Get File Metadata

GOOGLEDRIVE_GET_FILE_METADATA

Get metadata for a single Google Drive file.

Arguments

ArgumentTypeRequiredDescription
fileIdstringYesDrive file id
supportsAllDrivesbooleanNoWhether the request applies to all drives. Default: false.

Move File

GOOGLEDRIVE_MOVE_FILE

Move a Google Drive file between folders.

Arguments

ArgumentTypeRequiredDescription
add_parentsstringNoComma-separated folder ids to add
file_idstringYesDrive file id
remove_parentsstringNoComma-separated folder ids to remove
supports_all_drivesbooleanNoWhether the request applies to all drives. Default: false.

Delete File

GOOGLEDRIVE_DELETE_FILE

Delete a Google Drive file by id.

Arguments

ArgumentTypeRequiredDescription
fileIdstringYesDrive file id
supportsAllDrivesbooleanNoWhether the request applies to all drives. Default: false.

Copy File

GOOGLEDRIVE_COPY_FILE

Copy a Google Drive file, optionally with a new title.

Arguments

ArgumentTypeRequiredDescription
file_idstringYesDrive file id
new_titlestringNoTitle for the copy

Add File Sharing Preference

GOOGLEDRIVE_ADD_FILE_SHARING_PREFERENCE

Add a sharing permission (role + type) to a Google Drive file.

Arguments

ArgumentTypeRequiredDescription
domainstringNoDomain for domain-type permissions
email_addressstringNoEmail for user/group-type permissions
file_idstringYesDrive file id
rolestring, one of owner, organizer, fileOrganizer, writer, commenter, readerYesPermission role
typestring, one of user, group, domain, anyoneYesPermission type

Upload File

GOOGLEDRIVE_UPLOAD_FILE

Upload a file to Google Drive from a previously uploaded blob.

Arguments

ArgumentTypeRequiredDescription
file_to_uploadobjectYesUploaded file descriptor
parent_idstringNoParent folder id

Create Folder

GOOGLEDRIVE_CREATE_FOLDER

Create a new folder in Google Drive.

Arguments

ArgumentTypeRequiredDescription
folder_namestringYesName of the new folder
parent_idstringNoParent folder id

Create File From Text

GOOGLEDRIVE_CREATE_FILE_FROM_TEXT

Create a new text file in Google Drive with the given content.

Arguments

ArgumentTypeRequiredDescription
file_namestringYesName of the new file
text_contentstringYesText content of the file

Export Google Workspace File

GOOGLEDRIVE_EXPORT_GOOGLE_WORKSPACE_FILE

Export a Google Workspace file (Docs/Sheets/Slides) to another format.

Arguments

ArgumentTypeRequiredDescription
fileIdstringYesDrive file id
mimeTypestringYesTarget MIME type (e.g. application/pdf)

Google Docs

Get Document Plaintext

GOOGLEDOCS_GET_DOCUMENT_PLAINTEXT

Get the plaintext content of a Google Doc.

Arguments

ArgumentTypeRequiredDescription
document_idstringYesGoogle Docs document id

Insert Text

GOOGLEDOCS_INSERT_TEXT_ACTION

Insert text into a Google Doc, optionally appending to the end.

Arguments

ArgumentTypeRequiredDescription
append_to_endbooleanNoAppend at the end of the document. Default: true.
document_idstringYesGoogle Docs document id
text_to_insertstringYesText to insert

Replace All Text

GOOGLEDOCS_REPLACE_ALL_TEXT

Replace all occurrences of a string in a Google Doc.

Arguments

ArgumentTypeRequiredDescription
document_idstringYesGoogle Docs document id
find_textstringYesText to find
match_casebooleanNoCase-sensitive match. Default: false.
replace_textstringYesReplacement text

Create Document

GOOGLEDOCS_CREATE_DOCUMENT

Create a new Google Doc with an optional initial text.

Arguments

ArgumentTypeRequiredDescription
textstringNoOptional initial text content
titlestringYesTitle of the new document

Google Slides

Create Presentation

GOOGLESLIDES_CREATE_PRESENTATION

Create a new Google Slides presentation.

Arguments

ArgumentTypeRequiredDescription
titlestringYesTitle of the new presentation

Get Presentation

GOOGLESLIDES_PRESENTATIONS_GET

Get a Google Slides presentation by id.

Arguments

ArgumentTypeRequiredDescription
presentationIdstringYesPresentation id

Copy From Template

GOOGLESLIDES_PRESENTATIONS_COPY_FROM_TEMPLATE

Copy a Google Slides presentation from a template.

Arguments

ArgumentTypeRequiredDescription
new_titlestringNoTitle for the copy
parent_folder_idstringNoDestination folder id
template_presentation_idstringYesTemplate presentation (Drive file) id

Batch Update Presentation

GOOGLESLIDES_PRESENTATIONS_BATCH_UPDATE

Apply a batch of update requests to a Google Slides presentation.

Arguments

ArgumentTypeRequiredDescription
presentationIdstringYesPresentation id
requestsarray of objectYesSlides batchUpdate requests

Google Meet

Get Meet

GOOGLEMEET_GET_MEET

Get a Google Meet space by name.

Arguments

ArgumentTypeRequiredDescription
namestringNoMeet space name (e.g. spaces/ABC or ABC)

Update Meet Space

GOOGLEMEET_UPDATE_SPACE

Update a Google Meet space (e.g. access type).

Arguments

ArgumentTypeRequiredDescription
access_typestring, one of TRUSTED, OPEN, RESTRICTEDNoNew access type
space_idstringYesMeet space id

Google Super

Google Super has no tools of its own. It is a connection that the tools of other toolkits run through.

Not offered here

This deployment does not offer these toolkits. Each one gives the reason, and the slugs of its tools.

Outlook

Microsoft's OAuth application is registered but has only been verified against a mocked Graph. A credentialed smoke verification is required before it is offered.

Tools: OUTLOOK_SEND_EMAIL, OUTLOOK_FETCH_EMAILS, OUTLOOK_FETCH_MESSAGE_BY_MESSAGE_ID.

OneDrive

Microsoft's OAuth application is registered but has only been verified against a mocked Graph. A credentialed smoke verification is required before it is offered.

Tools: ONE_DRIVE_MOVE_ITEM, ONE_DRIVE_GET_ITEM, ONE_DRIVE_LIST_FOLDER_CHILDREN, ONE_DRIVE_DELETE_ITEM, ONE_DRIVE_SEARCH_ITEMS, ONE_DRIVE_ONEDRIVE_CREATE_FOLDER, ONE_DRIVE_ONEDRIVE_CREATE_TEXT_FILE.

GitHub

No OAuth application is registered for this provider yet, so a managed connect flow cannot complete.

Tools: GITHUB_CREATE_AN_ISSUE, GITHUB_GET_ISSUE, GITHUB_LIST_ISSUES, GITHUB_CREATE_AN_ISSUE_COMMENT.

Notion

No OAuth application is registered for this provider yet, so a managed connect flow cannot complete.

Tools: NOTION_CREATE_PAGE, NOTION_GET_PAGE, NOTION_SEARCH, NOTION_UPDATE_PAGE.

Linear

No OAuth application is registered for this provider yet, so a managed connect flow cannot complete.

Tools: LINEAR_CREATE_ISSUE, LINEAR_GET_ISSUE, LINEAR_LIST_ISSUES, LINEAR_UPDATE_ISSUE, LINEAR_DELETE_ISSUE, LINEAR_ADD_COMMENT, LINEAR_GET_TEAMS, LINEAR_GET_USERS, LINEAR_GET_LABELS, LINEAR_GET_PROJECTS, LINEAR_GET_WORKFLOW_STATES, LINEAR_SEARCH_ISSUES, LINEAR_GET_ISSUE_COMMENTS.

Jira

No OAuth application is registered for this provider yet, so a managed connect flow cannot complete.

Tools: JIRA_CREATE_ISSUE, JIRA_GET_ISSUE, JIRA_LIST_ISSUES.

The same catalog as JSON is at /v1/specs/catalog. It needs no credential.