Skip to main content

Available Services

The gws CLI dynamically supports all these Google Workspace and Google Cloud APIs. Use any alias below as the <service> argument.
Alias(es)API NameVersionDescription
drivedrivev3Manage files, folders, and shared drives
sheetssheetsv4Read and write spreadsheets
gmailgmailv1Send, read, and manage email
calendarcalendarv3Manage calendars and events
admin, directoryadmindirectory_v1Manage users, groups, and devices
admin-reports, reportsadminreports_v1Audit logs and usage reports
docsdocsv1Read and write Google Docs
slidesslidesv1Read and write presentations
taskstasksv1Manage task lists and tasks
peoplepeoplev1Manage contacts and profiles
chatchatv1Manage Chat spaces and messages
vaultvaultv1Manage eDiscovery holds and exports
groupssettingsgroupssettingsv1Manage Google Groups settings
resellerresellerv1Manage Workspace subscriptions
licensinglicensingv1Manage product licenses
apps-script, scriptscriptv1Manage and execute Apps Script projects
classroomclassroomv1Manage classes, rosters, and coursework
cloudidentitycloudidentityv1Manage identity groups and memberships
alertcenteralertcenterv1beta1Manage Workspace security alerts
formsformsv1Read and write Google Forms
keepkeepv1Manage Google Keep notes
meetmeetv2Manage Google Meet conferences
eventsworkspaceeventsv1Subscribe to Google Workspace events
modelarmormodelarmorv1Filter user-generated content for safety
workflow, wfworkflowv1Cross-service productivity workflows

Usage

Every service listed above can be used with gws:
gws <service> <resource> <method> [flags]

Examples

gws drive files list --params '{"pageSize": 10}'

Discovery

The gws CLI reads Google’s Discovery Service at runtime. If Google adds new API endpoints or methods, gws automatically picks them up without requiring an update.

Unlisted APIs

To use an API not in the table above, specify it using <api>:<version> syntax:
gws pubsub:v1 projects topics list --params '{"project": "projects/PROJECT_ID"}'

Introspecting Services

Use --help at any level:
Service-level help
gws drive --help
Resource-level help
gws drive files --help
Method-level help
gws drive files list --help

Schema Introspection

Inspect request/response schemas for any method:
gws schema drive.files.list
gws schema gmail.users.messages.send --resolve-refs

Service-Specific Pages

Detailed command examples for popular services:

Drive

Files, folders, and permissions

Gmail

Email operations

Calendar

Events and scheduling

Sheets

Spreadsheet data

Docs

Document editing

Chat

Messaging and spaces

Admin

User and group management

Overview

Command structure and patterns

Helper Commands

Some services include helper commands (prefixed with +):
ServiceHelperDescription
Drive+uploadUpload a file with auto-detection
Gmail+sendSend a simple email
Gmail+watchSet up push notifications
Gmail+triageQuery and mark messages as read
Calendar+insertCreate an event with simple syntax
Sheets+appendAppend rows to a spreadsheet
Sheets+readRead values from a range
Docs+writeAppend text to a document
Chat+sendSend a message to a space
See individual service pages for helper command documentation.

Authentication

All services use the same authentication mechanism. See the Authentication guide for setup instructions. Some services (like Admin SDK) require specific OAuth scopes or domain-wide delegation. Check the service-specific pages for details.