Skip to content

Quick Start

The CLI uses OAuth with tokens stored in your OS keyring.

Terminal window
# Login (opens browser)
webex login
# Check auth status
webex auth status
# List stored accounts
webex auth list
# Switch between accounts
webex auth switch user@example.com

You can also use a token directly:

Terminal window
webex --token "$WEBEX_TOKEN" calling people list
webex admin <resource> <action> [flags] # Webex Admin APIs
webex calling <resource> <action> [flags] # Webex Calling APIs
webex cc <resource> <action> [flags] # Contact Center APIs
webex device <resource> <action> [flags] # Webex Device APIs
webex meetings <resource> <action> [flags] # Webex Meetings APIs
webex messaging <resource> <action> [flags] # Webex Messaging APIs
FlagDescription
--token <token>Override authentication
--user <email>Use a specific authenticated user
--organization <orgId>Override org ID
--output json|table|csv|rawOutput format (default: json)
--debugShow HTTP request/response details
--paginateAuto-paginate list results
Terminal window
# List people in the organization
webex admin people list --max 10
# List licenses
webex admin licenses list
# List roles
webex admin roles list
Terminal window
# List people
webex calling people list --max 10
# Get your own details
webex calling people get-my-own
# List locations
webex calling locations list
# List devices
webex calling devices list

CC commands auto-populate --orgid from your login:

Terminal window
# List sites
webex cc site list
# List teams
webex cc team list
# List users
webex cc users list
# List queues
webex cc contact-service-queue list
# List entry points
webex cc entry-point list
# With filtering
webex cc site list --filter='name=="Site A"'
# With pagination
webex cc entry-point list --paginate
Terminal window
# List devices
webex device devices list
# List workspaces
webex device workspaces list
Terminal window
# List meetings
webex meetings meetings list
# List recordings
webex meetings recordings list --paginate
# List transcripts
webex meetings transcripts list
Terminal window
# List rooms
webex messaging rooms list
# List messages in a room
webex messaging messages list --room-id "ROOM_ID"
# List teams
webex messaging teams list
Terminal window
# Pretty JSON (default)
webex cc site list
# Table format
webex cc site list --output=table
# CSV format
webex admin people list --output=csv
# Raw JSON
webex cc site list --output=raw
# Save to file
webex cc site list > sites.json

Use --help at any level to see available commands:

Terminal window
webex --help
webex admin --help
webex calling --help
webex cc --help
webex device --help
webex meetings --help
webex messaging --help
webex cc users --help