Guides Dashboard Welcome

Getting Started

Getting Started Authentication Environments

Guides

Tickets Webhooks Error Handling Pagination

API Reference

Accept Invitation POST Accept Policy POST Ack Platform Alert POST Acknowledge Security Alert POST Activate Tenant POST Add Annotation POST Add Holiday POST Add Tag POST Approve Proposed Products POST Assign Role To User POST Beta Signup POST Billing Webhooks Process POST Bulk Toggle Support POST Bulk Update Notifications POST Call Me Test POST Cancel Tenant POST Change Plan POST Check Organization Name GET Clear Rate Limit Override DELETE Complete Test Call Step POST Create Access Request POST Create Api Key POST Create Checkout Session POST Create Configuration Template Version POST Create Customer Portal Session POST Create Delete Request POST Create Document V2 POST Create Incident POST Create Kb Article POST Create Known Product POST Create Llm Configuration POST Create Tenant Backup POST Create Ticket POST Create User POST Create Webhook POST Deactivate Tenant User DELETE Delete Api Key DELETE Delete Holiday DELETE Delete Known Product DELETE Delete Llm Configuration DELETE Delete User DELETE Delete Webhook DELETE Dev Login POST Download Access Export GET Download Export GET Download Export GET Export Audit Logs GET Export Audit Logs GET Export Billing Csv GET Export Configuration GET Export Conversation POST Export Tenant Kubernetes Logs GET Ga Signup POST Get Active Alerts GET Get Agent Settings GET Get Agent Settings History GET Get Agent Settings Internal GET Get All Tags GET Get Annotations GET Get Audit Log GET Get Audit Settings GET Get Auth Policy GET Get Auth Policy Internal GET Get Available Voices GET Get Available Voices Flat GET Get Azure AD configuration GET Get Billing Dashboard GET Get Billing Overview GET Get Business Hours GET Get Business Hours Internal GET Get Cache Settings GET Get Cache Settings Internal GET Get Call GET Get Call Metrics GET Get Call Recording GET Get Call Transcript GET Get Config GET Get Configuration Health Check GET Get Configuration History GET Get Consent Status GET Get Conversation GET Get Current Number GET Get Current Tenant Info GET Get Degradation Status GET Get Degradation Status GET Get Document GET Get Escalation Rules GET Get Escalation Rules Internal GET Get Feature Flags GET Get Feature Flags Internal GET Get Freshservice Settings GET Get Itsm Credentials Internal GET Get Itsm Provider Config GET Get Itsm Provider Internal GET Get Kb Pipeline Settings GET Get Kb Pipeline Settings Internal GET Get Kb Settings GET Get Kb Settings Internal GET Get Known Product GET Get Llm Configuration GET Get Llm Models GET Get Me GET Get Metrics Summary GET Get Onboarding State GET Get Platform Health GET Get public Azure AD configuration GET Get Rate Limit Override GET Get Recording File GET Get Recording Settings GET Get Recording Settings Internal GET Get Recording Settings Stats GET Get Recording Url GET Get Requester GET Get Requirements GET Get Resolution Rates GET Get Service Catalog GET Get Service Catalog Internal GET Get Service Catalog Settings GET Get Service Catalog Sync Status GET Get Status Page GET Get Subscription GET Get Sync Status GET Get System Health GET Get Tenant Detail GET Get Tenant Hpa GET Get Tenant Kubernetes Logs GET Get Tenant Quota GET Get Tenant Usage Summary GET Get Ticket GET Get Turn Detector Settings GET Get Turn Detector Settings Internal GET Get Twilio Settings GET Get Twilio Settings Internal GET Get Usage Patterns GET Get User GET Get Voice Preview POST Get Voice Settings GET Get Voice Settings Internal GET Grant Recording Consent POST Health Check GET Health V2 GET Impersonate Tenant POST Import Configuration POST Invite Tenant User POST List Api Keys GET List Audit Logs GET List Audit Logs GET List Calls GET List Categories GET List Configuration Template Versions GET List Configuration Templates GET List Consent Records GET List Conversations GET List Documents GET List Dsar Requests GET List Exports GET List Folders GET List Invoices GET List Known Products GET List Llm Configurations GET List Notification Preferences GET List Numbers GET List Plans GET List Requesters GET List Security Alerts GET List Security Rules GET List Super Admin Roles GET List Tenant Backups GET List Tenant Users GET List Tenants GET List Tickets GET List User Roles GET List Users GET List Webhook Deliveries GET List Webhooks GET Login POST Logout POST Onboarding Reminders POST Preview Document V2 POST Preview Pdf POST Prometheus Metrics GET Provision Number POST Provision Sandbox Tenant POST Provision Tenant POST Public Health GET Public Status GET Reactivate Tenant POST Refresh Configuration Cache POST Remove Role From User DELETE Remove Tag DELETE Replay Billing Webhook POST Request Export POST Request Export POST Resolve Security Alert POST Restore Tenant Backup POST Restore Tenant Backup To Point POST Revoke Api Key POST Revoke Tenant Encryption Key POST Rollback Configuration POST Rollback Itsm Provider Credentials POST Root GET Rotate Api Key POST Rotate Itsm Provider Credentials POST Rotate Tenant Encryption Key POST Rotate Tenant Encryption Key Legacy POST Run Test Call Diagnostics POST Scan Kb For Products Endpoint POST Search By Phone GET Search Numbers GET Set Default Service Category PUT Set Primary Number PUT Set Rate Limit Override POST Slug Preview GET Stripe Report Usage POST Stripe Webhook POST Submit Feedback POST Subscribe POST Suspend Tenant POST Sync Requesters POST Sync Service Catalog POST Sync Service Catalog POST Tenant Backup Run POST Tenant Hard Delete Cleanup POST Tenant Hpa Monitor POST Tenant Log Monitor POST Tenant Metrics Export GET Tenant Quota Monitor POST Test Azure AD connection POST Test Itsm Provider Connection POST Test Itsm Provider Ticket Creation POST Test Llm Configuration POST Test Twilio Connection POST Toggle Support Enabled PUT Trigger Sync POST Unsubscribe POST Update Agent Settings PUT Update Audit Settings PUT Update Auth Policy PUT Update Azure AD configuration PUT Update Business Hours PUT Update Cache Settings PUT Update Config PATCH Update Escalation Rules PUT Update Feature Flags PUT Update Freshservice Settings PUT Update Incident PATCH Update Itsm Provider Config PUT Update Kb Pipeline Settings PUT Update Kb Settings PUT Update Known Product PUT Update Llm Configuration PUT Update Llm Priorities PUT Update Onboarding State PUT Update Recording Settings PUT Update Security Rule PUT Update Service Catalog PUT Update Service Catalog Order PUT Update Service Catalog Settings PUT Update Tenant Organization PUT Update Tenant Quota PATCH Update Tenant User PUT Update Ticket PATCH Update Turn Detector Settings PUT Update Twilio Settings PUT Update User PUT Update Voice Settings PUT Usage Aggregate POST Usage Details GET Usage Events Retention POST Usage Summary GET Verify Subscription POST Withdraw Recording Consent POST

Api

Health V2

GET

/api/v2/health

Response Body

`application/json`

curl -X GET "https://loading/api/v2/health"

{}

Health Check GET

Basic health check endpoint.

Impersonate Tenant POST

Next Page