Skip to content
Docs
Knowledge Base
Docs
API Reference
Blog
Search
Ctrl
K
Cancel
Login
Sign Up
Knowledge Base
Docs
API Reference
Blog
Getting Started
Introduction
Platform Overview
Quick Start
Account Setup
Navigating Switchboard
Switchboard
Sign-in & Security
Logging In
Creating Your Account
Two-Factor Authentication
Resetting Your Password
Setting Your Password
Changing Your Password
Email Verification & Activation
Suspended Accounts
Account
Account Settings
Billing & Invoices
Subscriptions
Managing Subscriptions
Subscription Details
Users
Managing Users
User Details & Roles
Permission Groups
Overview
Creating & Editing Groups
Partner Access
Phone Numbers
Managing Phone Numbers
Buying Numbers
Porting Numbers In
Number Details & E911
10DLC Brands & Campaigns
Toll-Free Verification
Audit Log
Compliance
Cancelling Your Account
Leaving SIPSTACK
SARA Assistant
Using SARA
AI Skills
Nova PBX
Overview
Dashboard
People & Extensions
Set Up Your Team
Extensions
Adding & Editing Extensions
Departments
Locations
Call Routing
Inbound Routes
Routing Profiles
Ring Groups
IVR Menus
Time Conditions
Dial Permissions
Blocked Numbers
Call Center
Queues
Creating & Editing Queues
Agents
Skills
Wallboard
Reporting
Collaboration
Conferences
Paging Groups
Parking Lots
Phonebook
Analytics
Call Insights
Call History (CDRs)
Voicemail
Fax
Usage
Change Log
Media
Greetings
Music on Hold
Devices
Devices
Device Templates
Phone Profiles
Telair Provisioning Bridge
System
PBX Settings
Recording Settings
Feature Codes
Reference
Network Requirements
E911
Flare SMS
Overview
Dashboard
Conversations
Export Messages
Campaigns
Managing Campaigns
Creating & Editing Campaigns
Contacts
Templates
Analytics
Sending Speeds
Signup Forms
Auto-Responders
Reply Routing
Compliance
Aura AI
Overview
Voice Studio
Voice Library
Create Audio
Clone Voice
Agents
AI Voice Agents
Building & Editing Agents
Flow Builder Concepts
Authoring Agents in YAML
Booking Appointments in a Call
Connections
Knowledge Base
Insights
Transcription & Call Intelligence
My Workspace
Overview
My Phone
My Devices
Your Voicemail
Voicemail Settings
Call Forwarding
Your Call History
Pulse
Getting Started
What Is Pulse
Installing Pulse
Signing In
First-Run Setup
Calls
Making Calls (Dialpad)
In-Call Controls
Incoming Calls
Call History
Voicemail
Contacts
Messages
Text Messaging (SMS/MMS)
Fax
Settings
Profile & Account
Calling Preferences
Blocked Numbers
Notifications
Audio Devices
Emergency Location (E911)
Troubleshooting
Not Registered / Can't Call
Missed Calls & Background Wake
Audio & Microphone
Billing & Plans
Plans & What's Included
Usage & Limits
SMS Usage, Limits & Billing
How Aura AI Usage & Credits Work
Invoices
Subscription Lifecycle
Rewards Program
Partners
The Program
Overview
Channel Partners
Affiliates
Stripe Connect Setup
Partner Portal
Partner Directory
Portal Guide
Overview
Onboarding
Dashboard
Insights
Managing Customers
Working in a Customer's Account
Quotes
Earnings
Statements
Invitations
Perks & Seats
Settings
Team Management
Tax & Invoicing
Year-End T4A Filing
Developers
Quick Start
API Overview
Authentication
API Keys
Webhooks
Rate Limits
Error Codes
Pagination
Idempotency
Versioning
Changelog
Integrations Overview
API Reference
Overview
Nova
Overview
List call history (CDRs)
List Nova call history (CDRs)
Click-to-call (originate)
Get a Nova call (CDR)
List phone numbers (DIDs)
List extensions
List voicemails
Get a voicemail
Get a voicemail audio URL
Get a call recording
Get a call transcription
Flare
Overview
Send an SMS or MMS message
List SMS/MMS history
Get a single message
List & search contacts
Create a contact
Get a contact
Delete a contact
Update a contact
Opt a contact out of messaging
Opt a contact back into messaging
List SMS opt-outs
List campaigns
Create a campaign
Get a campaign
Send or schedule a campaign
List a campaign's messages
Get campaign analytics
List contact lists
Create a contact list
Get a contact list
Delete a contact list
Update a contact list
List a list's members
Add members to a list
Remove members from a list
Aura
Overview
List Aura voice-agent calls
Trigger an outbound agent call (not generally available)
Get an Aura call with transcript
List voice agents
Get a voice agent
Get an agent's knowledge-base tags
Set an agent's knowledge-base tags
Numbers
Overview
List your DID inventory
Search available numbers
Order a number
Register E911 for a number
Account
Overview
Identify the API key's organization
API Keys
Overview
List API keys
Create an API key
API key usage statistics
Revoke an API key
Regenerate an API key
Delete an API key
Webhooks
Overview
List webhook endpoints (portal session)
Create a webhook endpoint (portal session)
List delivery attempts
Send a test event
Delete a webhook endpoint (portal session)
Webhooks (API key)
Overview
Discover the webhook event catalog
List webhook endpoints (API key)
Create a webhook endpoint (API key)
Delete a webhook endpoint (API key)
Portal Authentication
Overview
Login
Complete a two-factor login
Refresh an expired session token
Logout
Get current session
Switch active organization
Portal Account
Overview
Get organization profile
List subscriptions
List phone numbers
Help & Support
How Support Works
Common Issues
Network & Firewall
Contact Support
Changelog
What's New
Select theme
Dark
Light
Auto
Overview
Portal Authentication
Section titled “Portal Authentication”
Portal login, session, and token lifecycle.
Portal API — may change without notice.
Operations
Section titled “ Operations ”
POST
/v2/portal/auth/login
POST
/v2/portal/auth/2fa/login-verify
POST
/v2/portal/auth/token/refresh
POST
/v2/portal/auth/logout
GET
/v2/portal/auth/session
POST
/v2/portal/auth/switch-organization
