Platform

Fetch active broadcast announcement banner & maintenance mode (public/all tenants)

`application/json`

curl -X GET "https://example.com/api/tenant/announcements/active"

{  "maintenanceMode": true,  "broadcastAnnouncement": null}

`application/json`

curl -X GET "https://example.com/api/platform/plans/catalog"

{  "plans": [    null  ]}

List platform plans with subscriber metrics (super-admin)

`application/json`

curl -X GET "https://example.com/api/platform/plans"

{  "plans": [    null  ]}

Create a new platform plan (super-admin)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

basePriceMonthly?number|string|null

basePriceYearly?number|string|null

includedRestaurants?integer

Range0 <= value

Default10

overagePerRestaurantMonthly?number|string|null

overagePerRestaurantYearly?number|string|null

maxRestaurants?|

Range0 <= value

stripePriceIdBaseMonthly?string|null

stripePriceIdBaseYearly?string|null

stripePriceIdOverageMonthly?string|null

stripePriceIdOverageYearly?string|null

features?array<string>|

active?boolean

Defaulttrue

`application/json`

curl -X POST "https://example.com/api/platform/plans" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "success": true,  "id": 0}

Update a platform plan (super-admin editable pricing)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length

basePriceMonthly?number|string|null

basePriceYearly?number|string|null

includedRestaurants?integer

Range0 <= value

overagePerRestaurantMonthly?number|string|null

overagePerRestaurantYearly?number|string|null

maxRestaurants?|

Range0 <= value

stripePriceIdBaseMonthly?string|null

stripePriceIdBaseYearly?string|null

stripePriceIdOverageMonthly?string|null

stripePriceIdOverageYearly?string|null

features?array<string>|

active?boolean

`application/json`

curl -X PUT "https://example.com/api/platform/plans/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true}

List platform-wide audit logs (super-admin)

Query Parameters

page?string

Default"1"

limit?string

Default"50"

`application/json`

curl -X GET "https://example.com/api/platform/audit-logs"

{  "logs": [    null  ],  "pagination": {    "page": 0,    "limit": 0,    "total": 0,    "totalPages": 0  }}

Platform-wide counts (super-admin)

`application/json`

curl -X GET "https://example.com/api/platform/overview"

null

List reseller businesses with rich filtering & sorting (super-admin)

Query Parameters

search?string

status?string

stripe?string

hasRestaurants?string

sort?string

page?string

limit?string

`application/json`

curl -X GET "https://example.com/api/platform/businesses"

{  "businesses": [    null  ],  "pagination": {    "total": 0,    "page": 0,    "totalPages": 0  }}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length

slug*string

Length1 <= length

ownerEmail*string

Formatemail

ownerPassword*string

Length8 <= length

ownerName?string

supportEmail?string

Formatemail

`application/json`

curl -X POST "https://example.com/api/platform/businesses" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string",    "ownerEmail": "[email protected]",    "ownerPassword": "stringst"  }'

null

Delete a business and all its data (super-admin)

`application/json`

curl -X DELETE "https://example.com/api/platform/businesses/string"

{  "success": true}

Update a business (suspend/reactivate, rename) — super-admin

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length

status?string

Value in

"active"
"suspended"

supportEmail?|

Formatemail

`application/json`

curl -X PUT "https://example.com/api/platform/businesses/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "success": true}

Impersonate a reseller business (super-admin)

`application/json`

curl -X POST "https://example.com/api/platform/businesses/string/impersonate"

{  "token": "string",  "user": null,  "business": null}

List all users across all reseller tenants (super-admin)

Query Parameters

search?string

scope?string

page?string

limit?string

`application/json`

curl -X GET "https://example.com/api/platform/users"

{  "users": [    null  ],  "pagination": {    "total": 0,    "page": 0,    "totalPages": 0  }}

Dograh Voice AI telemetry & telephony system health (super-admin)

`application/json`

curl -X GET "https://example.com/api/platform/telemetry"

{  "activeConcurrentCalls": 0,  "totalCallsToday": 0,  "avgCallDurationSeconds": 0,  "dograhWorkflowHealth": "string",  "twilioPool": {    "totalNumbers": 0,    "assignedNumbers": 0,    "availableNumbers": 0  },  "recentCallLogs": [    null  ]}

Platform financial & MRR overview (super-admin)

`application/json`

curl -X GET "https://example.com/api/platform/financials"

{  "mrr": 0,  "arr": 0,  "activeSubscriptionsCount": 0,  "trialingCount": 0,  "cancelledCount": 0,  "estimatedOverageRevenue": 0,  "stripeConnectCount": 0,  "subscriptionDistribution": [    null  ],  "businessSubscriptions": [    null  ]}

Fetch overall platform system health & operational status (super-admin)

`application/json`

curl -X GET "https://example.com/api/platform/system-status"

{  "maintenanceMode": true,  "broadcastAnnouncement": null,  "services": [    {      "name": "string",      "status": "operational",      "latencyMs": 0,      "uptimePercentage": 0    }  ]}

Toggle platform maintenance mode (super-admin)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

`application/json`

curl -X POST "https://example.com/api/platform/maintenance" \  -H "Content-Type: application/json" \  -d '{    "enabled": true  }'

{  "maintenanceMode": true}

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

message*string

type*string

Value in

"info"
"warning"
"alert"

active*boolean

`application/json`

curl -X POST "https://example.com/api/platform/announcements" \  -H "Content-Type: application/json" \  -d '{    "message": "string",    "type": "info",    "active": true  }'

{  "broadcastAnnouncement": null}

Get the caller's business platform subscription + usage

`application/json`

curl -X GET "https://example.com/api/platform/subscription"

null

Start Stripe Checkout for a business's platform subscription (HappyVoice Stripe)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

interval*string

Value in

"monthly"
"yearly"

planId?number

successPath?string

`application/json`

curl -X POST "https://example.com/api/platform/checkout" \  -H "Content-Type: application/json" \  -d '{    "interval": "monthly"  }'

{  "success": true,  "url": "string"}

Verify a completed platform Checkout session and activate the subscription immediately

Called by the browser on return from Stripe Checkout. The webhook does the same work asynchronously, but the redirect normally beats it — without this the business would look unpaid right after paying.

Query Parameters

session_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/platform/verify-session?session_id=string"

{  "success": true,  "status": "string"}

Open the Stripe billing portal for the business's platform subscription

Response Body

`application/json`

curl -X POST "https://example.com/api/platform/billing-portal"

{  "success": true,  "url": "string"}

200application/json

200application/json

403application/json

200application/json

403application/json

201application/json

403application/json

200application/json

403application/json

404application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

201application/json

400application/json

403application/json

409application/json

200application/json

400application/json

403application/json

404application/json

200application/json

400application/json

403application/json

404application/json

200application/json

400application/json

403application/json

404application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

403application/json

200application/json

400application/json

403application/json

200application/json

400application/json

403application/json

200application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`