API Reference¶
AstraPBX provides a REST API for all platform operations. Full interactive documentation is available at:
- Swagger UI: devpbx.astradial.com/api-docs
- Scalar: devpbx.astradial.com/reference
- Staging: stagepbx.astradial.com/reference
Authentication¶
Org-level (API key)¶
POST /api/v1/auth/login
{ "api_key": "org_xxx", "api_secret": "plain-text-secret" }
→ { "token": "eyJ..." } # 24h JWT
User-level (Firebase + RBAC)¶
POST /api/v1/auth/user-login
{ "firebase_token": "eyJ..." }
→ { "token": "eyJ...", "user": { "role": "manager", "permissions": [...] } }
Admin (platform super-admin)¶
POST /api/v1/admin/auth
{ "admin_username": "admin", "admin_password": "..." }
→ { "token": "eyJ..." }
Endpoint groups¶
| Group | Base path | Auth | Description |
|---|---|---|---|
| Organisations | /api/v1/organizations | Admin | Create, list, update, delete orgs |
| Users & Extensions | /api/v1/users | Org JWT | SIP extension management |
| Platform Users | /api/v1/org-users | Org JWT + RBAC | RBAC user management |
| DIDs | /api/v1/dids | Org JWT | Phone number management |
| Trunks | /api/v1/trunks | Org JWT | SIP trunk connections |
| Queues | /api/v1/queues | Org JWT | Call queue management |
| Calls | /api/v1/calls | Org JWT | Call logs, recordings, live calls |
| Compliance | /api/v1/compliance | Org JWT + RBAC | Retention, consent, audit |
| Config | /api/v1/config | Org JWT + Admin role | Asterisk config deploy |
| Settings | /api/v1/settings | Org JWT | MSG91, WhatsApp config |
| Admin | /api/v1/admin | Admin JWT | Global settings, all orgs |