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

# List specialties

> Returns the distinct specialties observed across served slots, from the provider's `specialties` and the schedule's, each with its `system` and a `count` of the slots carrying it. It is a discovery aid for the `specialty` filter on `GET /v1/scheduling/slots`. Codes are each publisher's own. Requires a valid API key.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/scheduling/specialties
openapi: 3.1.0
info:
  title: haau3 Platform API
  version: 1.0.0-preview.4
  description: >-
    The haau3 platform API is in preview: it may change as we build, usually to
    add features or improve performance. Endpoints require an API key, sent as
    `Authorization: Bearer <key>`. Requests without a valid key return 401.
    Create a key in the dashboard at https://platform.haau3.com; a new
    organization starts on the free Developer plan. From 2026-11-01 a request
    past one of its plan's limits (requests a minute on every plan, requests a
    month on Developer) returns 429 with `Retry-After`. Every error under
    `/v1/fhir` is a FHIR `OperationOutcome` and every other error an RFC 9457
    problem; https://docs.haau3.com/errors lists every status, whether to retry
    it, and what a method a path does not take answers.
servers:
  - url: https://api.haau3.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Scheduling
    description: 'Provider availability (SMART Scheduling Links): slots and publishers.'
  - name: FHIR base
    description: >-
      What the FHIR R4 base at `/v1/fhir/r4` answers for every service on it:
      the `CapabilityStatement` that lists them all, and batch Bundles that
      carry several requests to any of them in one round trip.
  - name: Terminology
    description: >-
      FHIR terminology operations over the code systems listed in
      TerminologyCapabilities. Some are resolved from their own source when you
      ask; others are held here at a named release, which that resource also
      names.
  - name: Provider directory
    description: >-
      CMS's National Provider Directory as FHIR R4: practitioners and their
      roles, organizations, payers and insurance networks, network membership,
      healthcare services, locations and endpoints. Every parameter the service
      serves is declared here, and any other is refused by name rather than
      ignored.
  - name: Questionnaires
    description: >-
      FHIR Questionnaire, served as its source publishes it. This service holds
      copies of a curated set and reaches any other questionnaire its source
      publishes by canonical URL, as well as forms published at their own
      address under places this service is set up to reach. Read one by id, and
      build the QuestionnaireResponse in your own application.
  - name: Plan Benefits
    description: >-
      FHIR InsurancePlan: what a Medicare Advantage or ACA Marketplace plan
      covers and what a member pays, read from the files CMS publishes. Every
      plan names the CMS release it was read from. Read a plan by its id, or
      search by identifier, name, state or county, and check whether the CMS
      National Provider Directory lists providers in a plan's network.
  - name: MedList
    description: >-
      One reconciled medication list from one patient's FHIR medication records,
      as US Core MedicationRequests with a Provenance for each. This operation
      receives patient data, so send it only under an executed agreement.
paths:
  /v1/scheduling/specialties:
    get:
      tags:
        - Scheduling
      summary: List specialties
      description: >-
        Returns the distinct specialties observed across served slots, from the
        provider's `specialties` and the schedule's, each with its `system` and
        a `count` of the slots carrying it. It is a discovery aid for the
        `specialty` filter on `GET /v1/scheduling/slots`. Codes are each
        publisher's own. Requires a valid API key.
      operationId: listSpecialties
      parameters:
        - name: includePast
          in: query
          required: false
          description: >-
            Also count slots that started before now. Defaults to `false`, so
            the counts cover the slots a search with no `startAfter` returns.
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          description: The distinct specialties across served slots.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSpecialtiesResponse'
              examples:
                The specialties:
                  summary: The specialties
                  value:
                    specialties:
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_98
                        display: Dentist
                        count: 1788
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_101
                        display: Dermatologist
                        count: 1013
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_518
                        display: Physician Assistant (Dermatology)
                        count: 886
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_157
                        display: Optometrist
                        count: 601
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_156
                        display: Chiropractor
                        count: 463
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_102
                        display: Family Physician
                        count: 420
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_401
                        display: Family Nurse Practitioner
                        count: 415
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_381
                        display: Physician Assistant
                        count: 302
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_99
                        display: Internist
                        count: 298
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_522
                        display: Nurse Practitioner (Dermatology)
                        count: 293
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_100
                        display: Pediatrician
                        count: 281
                      - system: http://nucc.org/provider-taxonomy
                        code: 207Q00000X
                        display: Family Medicine
                        count: 272
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_352
                        display: Psychotherapist
                        count: 271
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_121
                        display: Podiatrist
                        count: 194
                      - system: http://nucc.org/provider-taxonomy
                        code: 2084P0800X
                        display: Psychiatry Physician
                        count: 155
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_153
                        display: Primary Care Doctor
                        count: 151
                      - system: http://nucc.org/provider-taxonomy
                        code: 2085R0202X
                        display: Diagnostic Radiology Physician
                        count: 142
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_399
                        display: Nurse Practitioner
                        count: 131
                      - system: http://nucc.org/provider-taxonomy
                        code: 207RC0000X
                        display: Cardiovascular Disease Physician
                        count: 130
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_104
                        display: OB-GYN
                        count: 114
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_117
                        display: Orthopedic Surgeon
                        count: 108
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_335
                        display: Physical Therapist
                        count: 97
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_130
                        display: Ear, Nose & Throat Doctor
                        count: 82
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_151
                        display: Oral Surgeon
                        count: 61
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_106
                        display: Gastroenterologist
                        count: 57
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_367
                        display: Cosmetic Dermatologist
                        count: 52
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_279
                        display: Foot & Ankle Specialist
                        count: 50
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_406
                        display: Family Psychiatric & Mental Health Nurse Practitioner
                        count: 50
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_116
                        display: Ophthalmologist
                        count: 49
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_105
                        display: Cardiologist
                        count: 48
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_132
                        display: Allergist
                        count: 47
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_402
                        display: Pediatric Nurse Practitioner
                        count: 44
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_135
                        display: Orthodontist
                        count: 38
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_136
                        display: Periodontist
                        count: 38
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_144
                        display: Hand Surgeon
                        count: 38
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_368
                        display: Gynecologist
                        count: 38
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_539
                        display: Physician Assistant (Orthopedics)
                        count: 38
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_345
                        display: Acupuncturist
                        count: 36
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_528
                        display: Physician Assistant (ENT)
                        count: 32
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_338
                        display: Pediatric Dermatologist
                        count: 30
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_523
                        display: Nurse Practitioner (OB-GYN)
                        count: 30
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_152
                        display: Pediatric Dentist
                        count: 29
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_405
                        display: Adult Psychiatric & Mental Health Nurse Practitioner
                        count: 29
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_129
                        display: Sports Medicine Specialist
                        count: 28
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_108
                        display: Pulmonologist
                        count: 26
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_520
                        display: Physician Assistant (OB-GYN)
                        count: 25
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_128
                        display: Neurologist
                        count: 24
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_139
                        display: Pain Management Specialist
                        count: 24
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_122
                        display: Psychiatrist
                        count: 23
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_134
                        display: Endodontist
                        count: 23
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_137
                        display: Prosthodontist
                        count: 22
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_362
                        display: Midwife
                        count: 16
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_400
                        display: Adult Nurse Practitioner
                        count: 16
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_552
                        display: Nurse Practitioner (Pediatrics)
                        count: 15
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_403
                        display: Women's Health Nurse Practitioner
                        count: 14
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_337
                        display: Psychologist
                        count: 13
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_355
                        display: Interventional Cardiologist
                        count: 12
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_456
                        display: Speech-Language Pathologist
                        count: 12
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_541
                        display: Physician Assistant (Psychiatry)
                        count: 12
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_363
                        display: Hip and Knee Surgeon
                        count: 11
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_158
                        display: Surgeon
                        count: 10
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_258
                        display: Trauma Surgeon
                        count: 10
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_374
                        display: Occupational Therapist
                        count: 10
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_532
                        display: Physician Assistant (Allergy)
                        count: 10
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_242
                        display: Pediatric Endocrinologist
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_290
                        display: Spine Specialist
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_333
                        display: Cosmetic Dentist
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_371
                        display: Massage Therapist
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_525
                        display: Nurse Practitioner (Gastroenterology)
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_549
                        display: Physician Assistant (Pediatrics)
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_550
                        display: Nurse Practitioner (Orthopedics)
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_565
                        display: Nurse Injector
                        count: 8
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_511
                        display: Spine Surgeon
                        count: 7
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_127
                        display: Endocrinologist
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_142
                        display: Vascular Surgeon
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_167
                        display: Facial Plastic & Reconstructive Surgeon
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_353
                        display: Shoulder & Elbow Surgeon
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_407
                        display: Mental Health Nurse Practitioner
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_526
                        display: Nurse Practitioner (Pain Management)
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_534
                        display: Physician Assistant (Gastroenterology)
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_538
                        display: Physician Assistant (Vascular Surgery)
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_540
                        display: Physician Assistant (Pain Management)
                        count: 6
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_185
                        display: Hand & Microsurgery Specialist
                        count: 5
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_109
                        display: Rheumatologist
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_133
                        display: Colorectal Surgeon
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_155
                        display: Sleep Medicine Specialist
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_164
                        display: Head & Neck Surgeon
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_256
                        display: Bariatric Surgeon
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_364
                        display: Bariatric Physician
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_376
                        display: Optometric Glaucoma Specialist
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_448
                        display: Dermatology Nurse Practitioner
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_455
                        display: Neuropsychologist
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_519
                        display: Nurse Practitioner (Cardiology)
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_537
                        display: Physician Assistant (Cardiology)
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_585
                        display: Nurse Practitioner (Endocrinology)
                        count: 4
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_531
                        display: Nurse Practitioner (Psychiatry)
                        count: 3
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_113
                        display: Neurosurgeon
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_114
                        display: Infectious Disease Specialist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_126
                        display: Urologist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_146
                        display: Emergency Medicine Physician
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_170
                        display: Sinus Surgeon / Rhinologist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_197
                        display: Laryngologist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_212
                        display: Glaucoma Specialist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_255
                        display: Breast Surgeon
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_296
                        display: Pediatric Sports Medicine Specialist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_297
                        display: Procedural Dermatology Specialist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_339
                        display: Reproductive Endocrinologist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_347
                        display: Pediatric Allergist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_438
                        display: Marriage and Family Therapist
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_509
                        display: Behavior Analyst
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_553
                        display: Physician Assistant (Neurology)
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_558
                        display: Nurse Practitioner (Pulmonology)
                        count: 2
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_336
                        display: Physiatrist
                        count: 1
                      - system: https://www.zocdoc.com/fhir/CodeSystem/specialty
                        code: sp_447
                        display: Gerontology Nurse Practitioner
                        count: 1
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '400':
          description: >-
            A query parameter is not valid, is not one this endpoint takes, or
            was sent more than once. The problem's `issues` names each one and
            says why.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
        '401':
          $ref: '#/components/responses/ProblemUnauthorized'
        '406':
          $ref: '#/components/responses/ProblemNotAcceptable'
        '429':
          $ref: '#/components/responses/ProblemTooManyRequests'
        '500':
          $ref: '#/components/responses/ProblemServerError'
        '503':
          description: >-
            The scheduling service is unavailable, or its database did not
            answer in time. Send the request again after `Retry-After`. It is
            also the answer when the API key could not be checked just now, with
            `Retry-After`.
          headers:
            Retry-After:
              description: How many seconds to wait before sending the request again.
              schema:
                type: integer
                minimum: 0
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-Correlation-Id:
              $ref: '#/components/headers/XCorrelationId'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |
            curl "https://api.haau3.com/v1/scheduling/specialties" \
              -H "Authorization: Bearer $HAAU3_API_KEY"
        - lang: typescript
          label: TypeScript
          source: |
            import { Haau3 } from "@haau3/sdk";

            const haau3 = new Haau3(); // reads HAAU3_API_KEY
            const found = await haau3.listSpecialties();
            console.log(found.specialties.length);
        - lang: python
          label: Python
          source: |
            from haau3 import Haau3

            client = Haau3()  # reads HAAU3_API_KEY
            found = client.list_specialties()
            print(len(found["specialties"]))
        - lang: go
          label: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"log\"\n\n\t\"github.com/haau3/haau3-go\"\n)\n\nfunc main() {\n\tctx := context.Background()\n\tclient, err := haau3.NewClient() // reads HAAU3_API_KEY\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfound, err := client.ListSpecialties(ctx, haau3.ListSpecialtiesParams{})\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\tfmt.Println(len(found.Specialties))\n}\n"
components:
  parameters:
    XRequestId:
      name: X-Request-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: >-
        An id of your own for this request, as a UUID. It comes back in the
        `X-Correlation-Id` header and is kept with haau3's record of the
        request. Any value that is not a UUID is ignored. See
        https://docs.haau3.com/errors#request-ids.
  schemas:
    ListSpecialtiesResponse:
      type: object
      properties:
        specialties:
          type: array
          items:
            $ref: '#/components/schemas/SchedulingSpecialty'
      required:
        - specialties
      additionalProperties: false
    Problem:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: >-
            What kind of problem this is: an anchor on
            https://docs.haau3.com/errors.
          examples:
            - https://docs.haau3.com/errors#invalid-request
        title:
          type: string
          description: A short summary, the same for every occurrence of the type.
        status:
          type: integer
          description: The HTTP status code of this response.
        detail:
          type: string
          description: What went wrong this time, and how to correct it.
        instance:
          type: string
          format: uri
          description: >-
            This request's id as `urn:uuid:<id>`, the same id as the
            `X-Request-Id` header.
          examples:
            - urn:uuid:0b6f2d4e-8c1a-4e3b-9f5d-2a7c6e1b4d90
        issues:
          type: array
          description: 'On a 400: one entry per parameter that is not valid.'
          items:
            $ref: '#/components/schemas/ProblemIssue'
      required:
        - type
        - title
        - status
        - detail
        - instance
    SchedulingSpecialty:
      type: object
      properties:
        system:
          type: string
        code:
          type: string
        display:
          type: string
        count:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - count
      additionalProperties: false
    ProblemIssue:
      type: object
      properties:
        path:
          type: array
          description: The parameter, or the field within it, that is not valid.
          items:
            type:
              - string
              - integer
        message:
          type: string
          description: Why it is not valid.
      required:
        - path
        - message
  headers:
    XRequestId:
      description: >-
        The id haau3 gave this request, a UUID, on every response. Quote it in a
        question about the response. A problem carries the same id as its
        `instance`.
      schema:
        type: string
        format: uuid
    XCorrelationId:
      description: The `X-Request-Id` you sent, when it was a UUID.
      schema:
        type: string
        format: uuid
  responses:
    ProblemUnauthorized:
      description: Missing or invalid API key.
      headers:
        WWW-Authenticate:
          description: >-
            The scheme to authenticate with: `Bearer realm="api.haau3.com"`,
            with `error="invalid_token"` when a key was sent and not recognised.
          schema:
            type: string
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemNotAcceptable:
      description: The request's `Accept` header admits no JSON.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemTooManyRequests:
      description: >-
        A limit of the organization's plan was reached: its requests a minute,
        or the Developer plan's requests a month. Send the request again after
        `Retry-After`, which for the monthly limit runs to the 1st of the next
        month (UTC).
      headers:
        Retry-After:
          description: How many seconds to wait before sending the request again.
          schema:
            type: integer
            minimum: 0
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProblemServerError:
      description: The server failed to process this request.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        X-Correlation-Id:
          $ref: '#/components/headers/XCorrelationId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your platform API key (`haau3_sk_…`), sent as `Authorization: Bearer
        <key>`.

````

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