Command
nylas auth status
Check authentication status.
Written by Qasim Muhammad Staff SRE
What does nylas auth status do?
The nylas auth status command verifies whether the CLI is authenticated and the current token is valid. It checks API connectivity, token expiry, and grant health. Use it in CI/CD pipelines to fail early if credentials are missing.
Usage
nylas auth statusFlags
| Flag | Description |
|---|---|
| --json | Output as JSON |
| --no-color | Disable color output |
| --verbose(-v) | Enable verbose output |
| --config | Custom config file path |
| --help(-h) | Show help for the command |
| --limit | Limit results (most list commands) |
| --yes(-y) | Skip confirmations |
Examples
The nylas auth status command verifies whether the CLI is authenticated and the current token is valid.
Check status
nylas auth statusJSON for scripting
nylas auth status --jsonExample output
✓ Authenticated
Email: alice@example.com
Provider: google
Grant ID: grant_abc123
Status: valid
API Key: configured (us)Troubleshooting
Status shows unauthenticated
Run `nylas auth config --api-key` to set your API key, or `nylas auth login` for OAuth.
Token valid but API calls fail
Your API key may lack the required scopes. Check your Nylas dashboard application settings.
Recommended guides
List Fastmail emails from the CLI
List Fastmail emails from the CLI through Nylas IMAP access, using app passwords, inbox filters, JSON output, and Fastmail-specific auth troubleshooting.
Book meeting rooms from the CLI
Book meeting rooms from the CLI by listing calendar resources, using each room email as a calendar ID, and adding it as an event participant with less setup.
OfflineIMAP vs Nylas: Python IMAP sync
OfflineIMAP is a Python tool that syncs IMAP mail to local Maildir. Compare its config, Gmail OAuth2, sync speed, and an API email CLI that skips the mirror.
neomutt vs Nylas: IMAP reader vs email API
neomutt is a configurable IMAP terminal mail reader. Compare it to an API-backed email CLI on OAuth setup, scripting, offline access, and calendar reach.
mbsync vs Nylas: IMAP sync vs email API
mbsync (isync) syncs IMAP mailboxes to local Maildir for mutt or neomutt. Compare its sync model, Gmail OAuth setup, and where an API email CLI skips it.
Google Calendar API Sync Tokens
Use Google Calendar API sync tokens for incremental event sync, handle the 410 GONE full-resync, and read calendars from the CLI.
Run nylas auth status --help for full help output.