> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Get HIPAA mode status > Returns the workspace's HIPAA posture: whether HIPAA mode is on and since when, the Business Associate Agreement state with its acknowledgement history, the PHI retention policy, the at-rest encryption algorithm, and how many PHI access entries have been recorded. Read it before you start processing protected health information, or to render a compliance dashboard. The executed BAA document is never returned inline — only a presence flag. Owner/admin only. ## OpenAPI ````yaml /openapi.yaml get /api/v1/settings/hipaa openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Telegram description: >- Telegram bring-your-own-bot channel: connect a bot, verify a chat against the shared sandbox bot, and read unified channel state. Production sends go through the Messaging API. - name: USSD description: >- Menu-driven USSD for feature phones: define a menu tree, simulate session steps, and host the tenant-scoped aggregator callback. - name: Integrations description: Third-party service connections and OAuth management - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Messaging Services description: >- Twilio MessagingService-parity containers bundling sender pool, opt-out list, inbound webhook, and sticky-sender/geomatch flags - name: Sender Pools description: >- Group sending numbers into pools with a selection strategy (sticky / round-robin / random) for outbound sends - name: Opt-Out Lists description: >- Per-list STOP / HELP / START keyword sets and auto-response copy (Twilio Advanced Opt-Out parity) - name: SMPP description: Tenant BYO-SMPP bind credentials and upstream termination carriers - name: Commerce description: >- Unified omnichannel conversational-commerce: cart/checkout state machine, cross-channel payment reconciliation, hosted pay-by-link, native WhatsApp checkout, and agentic-checkout payment mandates - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/settings/hipaa: get: tags: - Settings summary: Get HIPAA mode status description: >- Returns the workspace's HIPAA posture: whether HIPAA mode is on and since when, the Business Associate Agreement state with its acknowledgement history, the PHI retention policy, the at-rest encryption algorithm, and how many PHI access entries have been recorded. Read it before you start processing protected health information, or to render a compliance dashboard. The executed BAA document is never returned inline — only a presence flag. Owner/admin only. parameters: - name: X-Test-Mode in: header required: false description: >- Sandbox opt-in for Clerk-session-authenticated requests. Set to `true` to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response `meta.test_mode: true`. **Ignored for live API keys (`dv_live_sk_*`)** — server-to-server clients must use a test-prefixed key (`dv_test_sk_*`) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header. schema: type: string enum: - 'true' - 'false' responses: '200': description: The organization's HIPAA status and configuration. content: application/json: schema: type: object description: The organization's HIPAA status and configuration. properties: data: type: object additionalProperties: true description: >- The organization's HIPAA posture — mode state, BAA lifecycle, retention policy and PHI access-log size. properties: enabled: type: - 'null' - boolean description: Whether HIPAA mode is currently active. enabled_at: type: - 'null' - string format: date-time description: >- When HIPAA mode was first acknowledged. Preserved across disable and re-enable cycles. last_enabled_at: type: - 'null' - string format: date-time description: Start of the most recent enable cycle. disabled_at: type: - 'null' - string format: date-time description: When HIPAA mode was last turned off, if it ever was. enable_history: type: - 'null' - array description: One entry per enable cycle, oldest first. items: type: object additionalProperties: true description: One HIPAA-mode enable cycle. properties: enabledAt: type: - 'null' - string format: date-time description: When the cycle started. disabledAt: type: - 'null' - string format: date-time description: When the cycle ended, if it has. baa_status: type: - 'null' - string description: >- Canonical Business Associate Agreement state — the same value the compliance BAA endpoint reports. Null when it cannot be read; fall back to `baa.signed`. hipaa_required: type: - 'null' - boolean description: >- Whether a signed BAA is required before this workspace may process protected health information. baa: type: object additionalProperties: true description: >- Business Associate Agreement state. The executed document is never returned inline — only a presence flag; download it through the compliance BAA download endpoint, which mints a short-lived signed URL. properties: signed: type: - 'null' - boolean description: Whether a BAA is currently in force. signedAt: type: - 'null' - string format: date-time description: >- Original acknowledgement time of the BAA in force. Preserved when the document is replaced. documentPresent: type: - 'null' - boolean description: >- Whether an executed BAA document is stored for the organization. history: type: - 'null' - array description: >- Earlier acknowledgements, so a compliance review can answer when each agreement was executed and when it was revoked. items: type: object additionalProperties: true description: One BAA acknowledgement. properties: signedAt: type: - 'null' - string format: date-time description: When that agreement was executed. revokedAt: type: - 'null' - string format: date-time description: When it was revoked, if it has been. documentPresent: type: - 'null' - boolean description: >- Whether a document was stored for that agreement. data_retention: type: - 'null' - object additionalProperties: true description: >- Automatic data-retention policy applied while HIPAA mode is on. properties: enabled: type: - 'null' - boolean description: Whether retention-based auto-deletion runs. days: type: - 'null' - integer description: >- Days data is retained before auto-deletion (30 to 3650). encryption_algorithm: type: - 'null' - string description: >- Algorithm protected health information is encrypted with at rest. phi_access_log_count: type: - 'null' - integer description: >- How many PHI access entries have been recorded. Page through them with GET /settings/hipaa/phi-access-log. meta: type: object properties: request_id: type: string description: >- Unique request identifier (also returned in X-Request-Id header) timestamp: type: string format: date-time description: ISO 8601 UTC timestamp of the response '400': $ref: '#/components/responses/StandardError' '401': $ref: '#/components/responses/StandardError' '403': $ref: '#/components/responses/StandardError' '404': $ref: '#/components/responses/StandardError' '422': $ref: '#/components/responses/StandardError' '429': $ref: '#/components/responses/RateLimitedResponse' '500': $ref: '#/components/responses/StandardError' components: responses: StandardError: description: >- Standard error envelope. `error.code` is machine-readable; see the [error reference](https://docs.orbit.devotel.io/reference/error-codes) for the catalogue. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation RateLimitedResponse: description: >- Rate limit exceeded. Wait `error.retry_after` seconds (or read the `Retry-After` header) before retrying. Returned when the request would exceed the bucket identified by `X-RateLimit-Bucket`. headers: X-RateLimit-Limit: description: Total request quota for the current window. schema: type: integer minimum: 0 X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer minimum: 0 X-RateLimit-Reset: description: >- Absolute unix-epoch-seconds timestamp at which the current window resets. schema: type: integer minimum: 0 X-RateLimit-Bucket: description: >- Name of the rate-limit bucket the request was bound by (e.g. `auth-write`, `money`, `agent-invoke`, or `custom:/`). Stripe-style — lets clients see which named cap they hit. schema: type: string RateLimit-Limit: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Limit`. Some SDKs read only this form. schema: type: integer minimum: 0 RateLimit-Remaining: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Remaining`. schema: type: integer minimum: 0 RateLimit-Reset: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror — delta seconds from now until the window resets (NOT epoch). schema: type: integer minimum: 0 Retry-After: description: >- RFC 7231 §7.1.3 — number of seconds the client should wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: type: object properties: error: type: object required: - code - message - status - retry_after properties: code: type: string enum: - RATE_LIMITED description: >- Always `RATE_LIMITED` — the global request-limiter 429. Distinct from `RATE_LIMIT_EXCEEDED`, the live per-recipient/per-tenant/per-resource frequency-cap 429 (not retired). message: type: string status: type: integer enum: - 429 retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Mirrors `Retry-After` header. meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````