api reference

All 401 methods, from one index.

One page per service, every method on it rendered at build time from the committed Discovery index the grr binary embeds — the same data grr api describe reads at runtime. Nothing here is hand-written, so nothing here can drift.

401 methods · 14 services · refreshed daily
pick a service

Fourteen services, one index.

Each card is one page. Every method of that service is on it, grouped by resource, with its verb, path, parameters, and scopes.

Gmail

Messages, threads, drafts, labels, history, filters, forwarding, send-as, and settings.

79 methods · v1 · 14 scopes

Calendar

Calendars, events, instances, ACL, free/busy, colors, and settings.

38 methods · v3 · 17 scopes

Drive

Files, permissions, comments, revisions, changes, drives, and team drives.

64 methods · v3 · 10 scopes

People (Contacts)

Contacts, connections, other contacts, contact groups, and directory people.

24 methods · v1 · 12 scopes

Chat

Spaces, messages, memberships, reactions, attachments, sections, and availability.

54 methods · v1 · 41 scopes

Forms

Form bodies, responses, publish settings, and push-notification watches.

10 methods · v1 · 6 scopes

Sheets

Spreadsheet values, batch updates, data filters, and developer metadata.

17 methods · v4 · 5 scopes

Tasks

Task lists and the tasks inside them. See the scope caveat below.

14 methods · v1 · 2 scopes

Slides

Presentation batch updates, page reads, and thumbnails.

5 methods · v1 · 7 scopes

Docs

Document create, read, and batch update.

3 methods · v1 · 5 scopes

Apps Script

Script projects, deployments, versions, processes, and running functions.

16 methods · v1 · 18 scopes

Analytics Admin

Accounts, properties, data streams, custom dimensions and metrics, conversion events, and the Ads and Firebase links.

55 methods · v1beta · 2 scopes

Analytics Data

Run reports — standard, realtime, pivot, and batch — plus compatibility checks, metadata, and audience exports.

11 methods · v1beta · 2 scopes

Search Console

Search analytics queries, sitemaps, sites, and URL inspection.

11 methods · v1 · 2 scopes

How this reference is generated

The pages under docs/api-reference/ are baked from the committed Discovery index at src/discovery/*.json — the same index the grr binary embeds and the generated command tree is compiled from.

That is the honesty contract: this reference is not hand-written, so it cannot drift from the binary. The daily Discovery workflow refreshes the index, the command tree regenerates, and these pages regenerate with it on the next deploy. The runtime equivalent of every entry is grr api describe + a method id — the same method id returns the verb, the path template, the scopes, and the parameters from the embedded index, offline, without a login.

Flags in the examples follow the generator’s naming rule: a parameter name is kebab-cased (userId → --user-id), and a name that would collide with a built-in flag is prefixed (format → --param-format, query → --param-query). The highlighted scope on every method is the narrowest .../auth/... entry — Discovery lists scopes broadest first, so it is the one that says what a call really touches.

how this is generated
# Every page under docs/api-reference/ is baked at build time from the
# committed index at src/discovery/*.json — the same index the binary
# embeds and the generated tree is compiled from, so the page and the
# binary can never drift. The daily Discovery workflow refreshes the
# index and the page regenerates with it on the next deploy.

# The runtime equivalent of every entry below: same index, offline, no login.
$ grr api describe gmail.users.messages.get
$ grr api list --service gmail --filter "batch"