Skip to content
proton-cli
Menu
DocsCommandsFAQStats
Start here
InstallFirst commandsHow a command is builtManaging proton itself
Everyday use
Naming what to act onFilters and bulk changesDry runs and confirmationsOutput and exit codesScriptingAI agentsSettings, files and environment
When something goes wrong
TroubleshootingWhat it can't do
Account
Guideproton accountproton account keysproton account sessionsproton account security-logproton account breachesproton account profilesproton account settings
Mail
Guideproton mail messagesproton mail conversationsproton mail draftsproton mail mailing-listsproton mail protectedproton mail settings
Drive
Guideproton drive itemsproton drive trashproton drive photosproton drive computersproton drive sharingproton drive linksproton drive sharedproton drive invitationsproton drive settingsproton drive volumes
Calendar
Guideproton calendar eventsproton calendar busy-timesproton calendar booking-pagesproton calendar remindersproton calendar invitationsproton calendar settings
Pass
Guideproton pass itemsproton pass vaultsproton pass aliasesproton pass linksproton pass sharingproton pass sharedproton pass invitationsproton pass trashproton pass breachesproton pass settingsimport, export, generate
Contacts
Guideproton contactsproton contacts emailsproton contacts groupsproton contacts keys
Local index
Guideproton index
Raw API
Guideproton api
About
FAQSecurityAll commandsChangelogProton API reference

Raw API

proton api sends an authenticated request to any Proton endpoint, using the session you already have. It is the escape hatch for anything the commands do not cover.

For every flag, see the reference.

Terminal window
proton api GET /drive/volumes
proton api GET /mail/v4/messages --query Page=0 --query PageSize=10
proton api POST /calendar/v1 --body '{"Name":"Work","Color":"#7272a7","Display":1,"AddressID":"..."}'
proton api DELETE /mail/v4/labels/LABEL_ID
proton api GET /calendar/v1 --output json | jq -r '.Calendars[].ID'

Responses come back as the API returned them, in Proton’s PascalCase.

Encrypted fields stay encrypted. This command does no key handling. For decrypted content, use the commands for that app.

Stdout carries the response and nothing else. A body that is not JSON - a proxy’s error page standing in for the API’s answer - goes to stderr instead, and the command exits 5. So a jq downstream is never handed something it cannot parse.

Find an endpoint

Section titled “Find an endpoint”

The API reference documents Proton’s endpoints: paths, methods, request and response schemas, and query parameters.

It is regenerated weekly from the Proton web clients’ source.

The spec behind it is served as openapi.yaml, for a code generator or an HTTP client to read.