> ## Documentation Index
> Fetch the complete documentation index at: https://docs.healos.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get note settings

> The Scribe settings notes are generated with for the clinician who owns this API key: default template, model, languages, terminology and specialty. Read-only. Requires the settings:read scope.

| Requirement | Detail |
| - | - |
| **Scope** | `settings:read` (rolling out: not yet on `api.healos.ai`) |
| **Rate limit** | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| **Cost** | Free |

> [!TIP]
>
> **Safety**
>
> * **Writes data:** No
> * **Safe to retry:** Yes
> * **Contacts an outside system:** None
> * **Dry run:** Not needed (read-only).

Guide: [Templates](https://docs.healos.ai/templates.md). Errors: [Error catalog](https://docs.healos.ai/errors.md).


## OpenAPI

````yaml openapi/ext-api-v1.json GET /settings/notes
openapi: 3.0.0
info:
  title: Healos External API
  version: 1.0.0
  description: >-
    External API for managing patients, documents, and appointments, listing
    providers and note templates, pulling clinical notes (with transcript and
    patient context), running insurance eligibility checks, browsing the EHR
    action catalog, reading AI Receptionist calls (summary, transcript,
    extracted details and recording), managing the AI Receptionist inbox tasks,
    and registering webhooks for note and document events.
servers:
  - url: https://api.healos.ai/ext-api/v1
    description: Production
  - url: http://localhost:8787/ext-api/v1
    description: Local development
security:
  - ApiKeyAuth: []
paths:
  /settings/notes:
    get:
      tags:
        - Settings
      summary: Get note settings
      description: >-
        The Scribe settings notes are generated with for the clinician who owns
        this API key: default template, model, languages, terminology and
        specialty. Read-only. Requires the settings:read scope.
      responses:
        '200':
          description: Note settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/NoteSettings'
                required:
                  - data
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitError'
components:
  schemas:
    NoteSettings:
      type: object
      properties:
        default_template_id:
          type: string
          nullable: true
          description: >-
            The template notes are generated with when no `template_id` is given
            (see GET /templates/{templateId}). Null when none resolves.
          example: 77777777-0000-0000-0000-000000000001
        model:
          type: string
          nullable: true
          description: Note generation model tier as chosen in Scribe settings.
          example: standard
        transcript_language:
          type: string
          nullable: true
          example: en
        note_language:
          type: string
          nullable: true
          example: en
        preserve_markdown_formatting:
          type: boolean
        include_prior_visit_by_default:
          type: boolean
          description: Whether new notes include the patient's previous visit by default.
        physician_term:
          type: string
          nullable: true
          description: How notes refer to the clinician.
          example: Dr.
        patient_term:
          type: string
          nullable: true
          description: How notes refer to the patient.
          example: Patient
        specialty:
          type: string
          nullable: true
          example: Podiatry
        cpt_restrict_to_specialty:
          type: boolean
          description: Whether CPT suggestions are limited to the specialty.
        include_signature_in_export:
          type: boolean
      required:
        - default_template_id
        - model
        - transcript_language
        - note_language
        - preserve_markdown_formatting
        - include_prior_visit_by_default
        - physician_term
        - patient_term
        - specialty
        - cpt_restrict_to_specialty
        - include_signature_in_export
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    RateLimitError:
      type: object
      properties:
        error:
          type: string
          example: Rate limit exceeded. Please retry after the window resets.
        code:
          type: string
          enum:
            - daily_cap_reached
          description: >-
            Set when the organization reached its daily cap for this paid
            operation (not on a per-minute limit).
        reset_at:
          type: string
          format: date-time
          description: 'With `code`: when the daily cap resets (next 00:00 UTC).'
          example: '2026-10-28T00:00:00.000Z'
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key obtained from /api/v1/ext-api-keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.