Elation Health

Elation Health Appointment Types API

The Appointment Types API from Elation Health — 4 operation(s) for appointment types.

GitHub OpenAPI
Business capability
Scheduling & Appointment Management BC-2800.10

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /appointment_types/ Find appointment types (legacy) · Find Appointment Types #
Ask an LLM
“How do I see the appointment types set up on the legacy endpoint?”
“What does the old unversioned appointment types list return?”
Tell an agent
Find all appointment types on the legacy endpoint.
Show the old-style appointment type catalog.
GET /appointment_types/{id} Look up an appointment type (legacy) · Get Appointment Type #
Ask an LLM
“Can I fetch a single appointment type from the legacy API?”
“Which legacy call shows the details of one visit type?”
Tell an agent
Fetch legacy appointment type {id}.
Show a single visit type from the original endpoint.
PATCH /appointment_types/{id} Edit an appointment type (legacy PATCH) · Update Appointment Type #
Ask an LLM
“Can I change an appointment type's color or abbreviation with the legacy PATCH?”
“How do I mark a visit type as telehealth on the old endpoint?”
Tell an agent
Set legacy appointment type {id}'s default duration to {default_duration} and color to {color}.
Flag the old-style visit type {name} as telehealth {is_telehealth}.
GET /api/2.0/appointment_types/ List appointment types · List Appointment Types #
Ask an LLM
“Which appointment types does my practice offer in Elation?”
“Can I search appointment types by name?”
Tell an agent
List appointment types for practice {practice}.
Find appointment types named {name}.
POST /api/2.0/appointment_types/ Create an appointment type · Create Appointment Type #
Ask an LLM
“How do I add a new visit type with a default length?”
“Can a new appointment type be bookable by patients?”
Tell an agent
Create appointment type {name} lasting {default_duration} minutes at practice {practice}.
Add a patient-bookable {patient_bookable} visit type {name} for practice {practice} with duration {default_duration}.
DELETE /api/2.0/appointment_types/{id}/ Delete an appointment type · Delete Appointment Type #
Ask an LLM
“How do I delete an appointment type we no longer use?”
“Can a visit type be removed in v2?”
Tell an agent destructive · confirm first
Delete appointment type {id}.
Remove v2 visit type {id}.
GET /api/2.0/appointment_types/{id}/ Get one appointment type · Retrieve Appointment Type #
Ask an LLM
“How do I read the settings of one appointment type in v2?”
“What note templates are linked to an appointment type?”
Tell an agent
Get appointment type {id}.
Retrieve v2 appointment type {id} with its templates.
PATCH /api/2.0/appointment_types/{id}/ Edit part of an appointment type · Partially Update Appointment Type #
Ask an LLM
“Can I change just the color of an appointment type in v2?”
“How do I change how many hours before a visit patient forms go out?”
Tell an agent
Change the color of appointment type {id} to {color}.
Send patient forms {patient_form_hours_prior} hours before visits of type {id}.
PUT /api/2.0/appointment_types/{id}/ Replace an appointment type · Update Appointment Type #
Ask an LLM
“Can I replace an appointment type's full configuration?”
“Which v2 call overwrites a visit type entirely?”
Tell an agent
Replace appointment type {id} with name {name} and duration {default_duration}.
Overwrite v2 appointment type {id} for practice {practice}.

Documentation

📖
Documentation
https://docs.elationhealth.com/docs/oauth
📖
APIReference
https://docs.elationhealth.com/reference/get-token
📖
Documentation
https://docs.elationhealth.com/reference/scopes
📖
Documentation
https://docs.elationhealth.com/docs/api-overview
📖
APIReference
https://docs.elationhealth.com/reference
📖
APIReference
https://docs.elationhealth.com/reference/insurance-eligibility
📖
APIReference
https://docs.elationhealth.com/reference/message-threads
📖
Documentation
https://docs.elationhealth.com/docs/webhooks
📖
APIReference
https://docs.elationhealth.com/reference/event-subscriptions
📖
Documentation
https://help.elationhealth.com/articles/rest/overview/api-overview
📖
APIReference
https://help.elationhealth.com/api-reference
📖
Authentication
https://help.elationhealth.com/articles/rest/overview/oauth

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/openapi/elation-health-appointment-types-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-appointment-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-patched-appointment-type-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/json-schema/elation-health-paginated-appointment-type-list-schema.json

Other Resources

🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/elation-health/refs/heads/main/asyncapi/elation-health-events-webhooks.yml
🔗
OAuthScopes
https://help.elationhealth.com/articles/rest/overview/scopes
🔗
ChangeLog
https://help.elationhealth.com/articles/rest/changelog/changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/elation-health:elation-health-appointment-types-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elation-health-appointment-types-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Elation Health Appointment Types API
  version: '1.0'
  description: 'Operations tagged Appointment Types across 2 of this provider''s published API definitions: elation-api-settings.json, elation-health-api-full-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox.elationemr.com/api/2.0
- description: Sandbox Server
  url: https://sandbox.elationemr.com
- description: Production Server
  url: https://api.app.elationemr.com
tags:
- name: Appointment Types
paths:
  /appointment_types/:
    get:
      summary: Find Appointment Types
      description: ''
      operationId: find-appointment-types
      parameters:
      - name: Authorization
        in: header
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"count\": 10,\n    \"next\": null,\n    \"previous\": null,\n    \"results\": [\n        {\n            \"id\": 12345678910,\n          \t// See Object Definition\n        }\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: python
          code: "import requests\nimport json\n\naccess_token = \"VFroUHsmrErlVI6nJ08Alwhri5RGCW\"\nauth_header = \"Bearer %s\" % (access_token)\n\nresp = requests.get(\"https://sandbox.elationemr.com/api/2.0/appointment_types/\",\n                    headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
        samples-languages:
        - python
      tags:
      - Appointment Types
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /appointment_types/{id}:
    get:
      summary: Get Appointment Type
      description: ''
      operationId: get-appointment-type
      parameters:
      - name: Authorization
        in: header
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"abbreviation\": \"T/APT\",\n    // See Object Definition\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: python
          code: "import requests\nimport json\n\naccess_token = \"VFroUHsmrErlVI6nJ08Alwhri5RGCW\"\nauth_header = \"Bearer %s\" % (access_token)\n\nresp = requests.get(\"https://sandbox.elationemr.com/api/2.0/appointment_types/12345678910\",\n                    headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
        samples-languages:
        - python
      tags:
      - Appointment Types
      security:
      - sec0: []
    patch:
      summary: Update Appointment Type
      description: ''
      operationId: update-appointment-type
      parameters:
      - name: Authorization
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                abbreviation:
                  type: string
                  description: Abbreviated name for the appointment type
                color:
                  type: string
                  description: The color of the appointment types when shown on the Elation calendar
                default_duration:
                  type: integer
                  description: Default duration of the appointment type, in minutes
                  format: int32
                description:
                  type: string
                  description: Description of the appointment type
                patient_forms_hours_prior:
                  type: integer
                  description: Patient forms advance hours for this appointment type
                  format: int32
                is_telehealth:
                  type: boolean
                  description: If appointment type is telehealth
                name:
                  type: string
                  description: Name of the appointment type
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"abbreviation\": \"T/APT\",\n    // See Object Definition\n}"
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: python
          code: "import requests\nimport json\n\naccess_token = \"TyEPKw8fVGRKpCBa81ygwjCLXDNIAm\"\nauth_header = \"Bearer %s\" % (access_token)\n\ndata = {\n    \"abbreviation\": \"T/APT\",\n    \"color\": \"\",\n    \"default_duration\": 30, \t\n    \"description\": \"Test appointment type PATCH\",\n    \"patient_forms\": [],\n    \"patient_form_hours_prior\": 72,\n    \"is_telehealth\": true,\n    \"name\": \"Test Appointment Type\"\n}\n\nresp = requests.patch(\"https://sandbox.elationemr.com/api/2.0/appointment_types/\",\n                     json=data,\n                     headers={'Authorization': auth_header,\n                              'Content-type': 'application/json'})\n\nprint(resp.status_code)\nprint(resp.text)"
        samples-languages:
        - python
      tags:
      - Appointment Types
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /api/2.0/appointment_types/:
    get:
      operationId: appointment_types_list
      parameters:
      - description: Number of results to return per page.
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: Multiple values may be separated by commas.
        explode: false
        in: query
        name: name
        schema:
          items:
            type: string
          type: array
        style: form
      - description: The initial index from which to return the results.
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: Which field to use when ordering the results.
        in: query
        name: order_by
        required: false
        schema:
          type: string
      - description: Multiple values may be separated by commas.
        explode: false
        in: query
        name: practice
        schema:
          items:
            format: int64
            type: integer
          type: array
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAppointmentTypeList'
          description: ''
      security:
      - oauth2: []
      summary: List Appointment Types
      tags:
      - Appointment Types
      x-el8-docs-category: Scheduling API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    post:
      description: Create a new appointment type.
      operationId: appointment_types_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentType'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppointmentType'
          description: ''
      security:
      - oauth2: []
      summary: Create Appointment Type
      tags:
      - Appointment Types
      x-el8-docs-category: Scheduling API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    servers:
    - description: Sandbox Server
      url: https://sandbox.elationemr.com
    - description: Production Server
      url: https://api.app.elationemr.com
  /api/2.0/appointment_types/{id}/:
    delete:
      description: Delete an existing appointment type.
      operationId: appointment_types_destroy
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '204':
          description: No response body
      security:
      - oauth2: []
      summary: Delete Appointment Type
      tags:
      - Appointment Types
      x-el8-docs-category: Scheduling API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    get:
      operationId: appointment_types_retrieve
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppointmentType'
          description: ''
      security:
      - oauth2: []
      summary: Retrieve Appointment Type
      tags:
      - Appointment Types
      x-el8-docs-category: Scheduling API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    patch:
      description: Update an existing appointment type.
      operationId: appointment_types_partial_update
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAppointmentType'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppointmentType'
          description: ''
      security:
      - oauth2: []
      summary: Partially Update Appointment Type
      tags:
      - Appointment Types
      x-el8-docs-category: Scheduling API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    put:
      description: Replace an existing appointment type.
      operationId: appointment_types_update
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppointmentType'
          description: ''
      security:
      - oauth2: []
      summary: Update Appointment Type
      tags:
      - Appointment Types
      x-el8-docs-category: Scheduling API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    servers:
    - description: Sandbox Server
      url: https://sandbox.elationemr.com
    - description: Production Server
      url: https://api.app.elationemr.com
components:
  schemas:
    AppointmentType:
      properties:
        abbreviation:
          type: string
        color:
          type: string
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        default_duration:
          type: integer
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        description:
          type: string
        elation_note_template_ids:
          items:
            type: integer
          type: array
        id:
          readOnly: true
          type: integer
        is_telehealth:
          type: boolean
        name:
          type: string
        patient_bookable:
          type: boolean
        patient_form_hours_prior:
          type: integer
        patient_forms:
          items:
            type: integer
          type: array
        practice:
          format: int64
          type: integer
        sequence:
          readOnly: true
          type: integer
        visit_note_format:
          oneOf:
          - $ref: '#/components/schemas/VisitNoteFormatEnum'
          - $ref: '#/components/schemas/NullEnum'
        visit_note_templates:
          items:
            format: int64
            type: integer
          type: array
        visit_note_type:
          format: int64
          type:
          - integer
          - 'null'
      required:
      - default_duration
      - name
      - practice
      type: object
    PatchedAppointmentType:
      properties:
        abbreviation:
          type: string
        color:
          type: string
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        default_duration:
          type: integer
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        description:
          type: string
        elation_note_template_ids:
          items:
            type: integer
          type: array
        id:
          readOnly: true
          type: integer
        is_telehealth:
          type: boolean
        name:
          type: string
        patient_bookable:
          type: boolean
        patient_form_hours_prior:
          type: integer
        patient_forms:
          items:
            type: integer
          type: array
        practice:
          format: int64
          type: integer
        sequence:
          readOnly: true
          type: integer
        visit_note_format:
          oneOf:
          - $ref: '#/components/schemas/VisitNoteFormatEnum'
          - $ref: '#/components/schemas/NullEnum'
        visit_note_templates:
          items:
            format: int64
            type: integer
          type: array
        visit_note_type:
          format: int64
          type:
          - integer
          - 'null'
      type: object
    VisitNoteFormatEnum:
      enum:
      - note2
      - oneCol.oneField
      - oneCol.preOp
      - oneCol.preOp2
      - oneCol.simple
      - twoCol.complex
      - twoCol.complex2
      type: string
    NullEnum:
      type: 'null'
    PaginatedAppointmentTypeList:
      properties:
        count:
          example: 123
          type: integer
        next:
          example: http://api.example.org/accounts/?offset=400&limit=100
          format: uri
          nullable: true
          type: string
        previous:
          example: http://api.example.org/accounts/?offset=200&limit=100
          format: uri
          nullable: true
          type: string
        results:
          items:
            $ref: '#/components/schemas/AppointmentType'
          type: array
      required:
      - results
      type: object
  securitySchemes:
    sec0:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://example.com/oauth2/token
          scopes: {}
    oauth2:
      flows:
        clientCredentials:
          scopes:
            act_as_user: Impersonate a provider via X-On-Behalf-Of (combinable with apiv2 or system scopes)
            apiv2: Full access to the API
            system/{resource_name}.read: Read access to a specific resource
            system/{resource_name}.write: Write access to a specific resource
          tokenUrl: /api/2.0/oauth2/token/
      type: oauth2
x-refined-from:
- elation-api-settings.json
- elation-health-api-full-openapi.yaml
x-readme:
  headers: []
x-readme-fauxas: true