Security-reviewed public contract
G3N MHS Support Query API
A versioned, non-mutating query contract for authorized support clients. The specification is public so clients can discover the protocol; every operational API route remains protected by authentication.
Connection
Production API address
https://api.g3nmhssupport.com
The custom API hostname is declared by the contract. Its production DNS and gateway mapping are tracked separately from this documentation site.
Authentication
Every one of the 21 operations requires either an HTTP bearer token or the documented HTTP Basic user-token form. Credentials are never URL parameters.
Read-only boundary
The contract excludes login, logout, customer replies, call control, routing mutations, synchronization, publishing, rollback, and browser-control routes.
Query surface
| Area | Methods | Purpose |
|---|---|---|
| System | GET | Shallow health, monitoring snapshots, and provider-reported daily costs. |
| Identity | GET | Current authenticated identity and the optional enabled-user directory. |
| Support calls | GET | Bounded recent-call lists and per-call event timelines. |
| Support emails | GET | Bounded conversation lists and per-conversation event timelines. |
| Tickets | GET, POST | Ticket taxonomy, lists, detail timelines, and an optional metered reply recommendation that does not save or send. |
| Twilio telemetry | GET | Locally retained interaction records and per-Call-SID detail. |
| Outbound calls | GET | Bounded bridge-session lists and optional transcript detail. |
| Phone routing | GET, POST | Current routing configuration, non-mutating checks, bounded analysis, and optional metered recommendations that do not publish. |
Data guarantees
Ordering
Each operation declares its order and tie-breakers. Undocumented collection order is not guaranteed.
Pagination
There are no client cursors or offsets. Limit-only routes return one leading window and cannot traverse past their maximum.
Time
Date parameters are UTC calendar dates. Explicit UTC fields use RFC 3339; timestamps inside opaque source payloads are not normalized.
Nullability
Until concrete schemas state otherwise, optional collections can be arrays, null, or absent. A list envelope's count is authoritative.
Retention
Nominal retention is documented per operation. Expiration is asynchronous and is not a minimum-availability guarantee.
Completeness
Local views do not prove upstream completeness unless an operation explicitly provides that guarantee.
Twilio telemetry limitation
The list endpoint accepts only limit, defaulting to 50 and capped at 100. Its nominal local retention defaults to 180 days. It does not query Twilio live and cannot establish that every upstream call or related record was collected.
Version and integrity
Current contract version: 2.0.1. Consumers that require immutable bytes should use the versioned URL and verify its SHA-256 digest.
8e02f1d56bd4416ff2b6bcb990a8367b1e914eecc15a6dea2b1140fe84f14362