Elation Health Staff Groups API

The Staff Groups API from Elation Health — 4 operation(s) for staff groups.

Operations 10

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 /staff_groups/ Find staff groups (legacy) · Find Staff Group #
Ask an LLM
“How do I look up a staff group by name on the older endpoint?”
“Which legacy call lists staff groups in a practice?”
Tell an agent
Find legacy staff groups named {name}.
Search older staff groups in practice {practice}.
POST /staff_groups/ Create a staff group (legacy) · Create Staff Group #
Ask an LLM
“How do I group front-desk users together through the unversioned route?”
“Can a legacy staff group be marked as an Elation group?”
Tell an agent
Create a legacy staff group {name} with users {users}.
Add an older-style staff group for practice {practice}, Elation group {is_elation_group}.
DELETE /staff_groups/ Delete a staff group (legacy) · Delete a Staff Group #
Ask an LLM
“How do I remove a staff group with the older delete call?”
“Which unversioned endpoint deletes a staff group?”
Tell an agent destructive · confirm first
Delete legacy staff group {id}.
Remove old staff group {id} via the unversioned route.
PUT /staff_groups/{id} Update a staff group (legacy) · Update Staff Group #
Ask an LLM
“How do I change a staff group's members on the older PUT route?”
“Can I rename a legacy staff group?”
Tell an agent
Update legacy staff group {id} to include users {users}.
Rename older staff group {id} to {name}.
GET /api/2.0/staff_groups/ List staff groups with paging · List Staff Groups #
Ask an LLM
“How do I page through staff groups in the v2.0 API?”
“Can I filter /api/2.0 staff groups by name and sort them?”
Tell an agent
List v2.0 staff groups in practice {practice}, {limit} per page.
Page through /api/2.0 staff groups named {name} from offset {offset}, ordered by {order_by}.
POST /api/2.0/staff_groups/ Create a staff group in the v2.0 API · Create Staff Group #
Ask an LLM
“What does /api/2.0 require to create a staff group?”
“How do I set up a new team of staff users in the v2.0 API?”
Tell an agent
Create v2.0 staff group {name} for practice {practice} with users {users}.
Set up an /api/2.0 staff team {name}, Elation group {is_elation_group}.
DELETE /api/2.0/staff_groups/{id}/ Delete a staff group in the v2.0 API · Delete Staff Group #
Ask an LLM
“How do I delete a staff group through /api/2.0?”
“Can I retire an unused v2.0 staff group?”
Tell an agent destructive · confirm first
Delete v2.0 staff group {id}.
Retire /api/2.0 staff team {id}.
GET /api/2.0/staff_groups/{id}/ Retrieve a staff group from the v2.0 API · Retrieve Staff Group #
Ask an LLM
“How do I fetch one staff group and its members from /api/2.0?”
“Who belongs to a given v2.0 staff group?”
Tell an agent
Retrieve v2.0 staff group {id}.
Show the members of /api/2.0 staff group {id}.
PATCH /api/2.0/staff_groups/{id}/ Partially update a staff group in v2.0 · Partially Update Staff Group #
Ask an LLM
“Can I change only the members of a v2.0 staff group?”
“How do I rename an /api/2.0 staff group without resending users?”
Tell an agent
Set the members of v2.0 staff group {id} to {users}.
Rename /api/2.0 staff team {id} to {name} and keep its members.
PUT /api/2.0/staff_groups/{id}/ Replace a staff group in the v2.0 API · Update Staff Group #
Ask an LLM
“How do I fully replace a staff group's name, practice and users in /api/2.0?”
“Which v2.0 call overwrites a staff group entirely?”
Tell an agent
Replace v2.0 staff group {id} with name {name}, practice {practice} and users {users}.
Overwrite /api/2.0 staff group {id} in full.

Documentation

Specifications

Schemas & Data

Other Resources

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-staff-groups-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.

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

OpenAPI Specification

elation-health-staff-groups-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Elation Health Staff Groups API
  version: '1.0'
  description: 'Operations tagged Staff Groups 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: Staff Groups
paths:
  /staff_groups/:
    get:
      summary: Find Staff Group
      description: ''
      operationId: find-staff-group
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: name
        in: query
        schema:
          type: string
      - name: practice
        in: query
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "[\n \t{\n  \t\"id\": 83792571234,\n  \t// See Object Definition\n\t},\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/staff_groups/\",\n                    headers={'Authorization': auth_header})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
        samples-languages:
        - python
      tags:
      - Staff Groups
      security:
      - sec0: []
    post:
      summary: Create Staff Group
      description: ''
      operationId: create-staff-group
      parameters:
      - name: Authorization
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                is_elation_group:
                  type: boolean
                users:
                  type: array
                  items:
                    type: integer
                    format: int32
                practice:
                  type: integer
                  format: int32
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": 140754688737550,\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       'name': 'group,         \n       'is_elation_group': False, \n       'users': [\n         140754687361026,\n         140754687361027\n       ], \n       'practice': 211,\n}\nresp = requests.post(\"https://sandbox.elationemr.com/api/2.0/staff_groups/\",\n                     data=json.dumps(data),\n                     headers={'Authorization': auth_header,\n                              'Content-type': 'application/json'})\n\nprint resp.status_code\nprint json.dumps(json.loads(resp.content), indent=2)"
        samples-languages:
        - python
      tags:
      - Staff Groups
      security:
      - sec0: []
    delete:
      summary: Delete a Staff Group
      description: ''
      operationId: delete-a-staff-group
      parameters:
      - name: id
        in: path
        schema:
          type: integer
          format: int64
        required: true
      responses:
        '204':
          description: '204'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '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\nresp = requests.delete(\"https://sandbox.elationemr.com/api/2.0/staff_groups/140754688737550\",\n                       headers={'Authorization': auth_header})\n\nprint resp.status_code"
        samples-languages:
        - python
      tags:
      - Staff Groups
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /staff_groups/{id}:
    put:
      summary: Update Staff Group
      description: ''
      operationId: update-staff-group
      parameters:
      - name: Authorization
        in: header
        schema:
          type: string
      - name: id
        in: path
        schema:
          type: integer
          format: int64
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  format: int64
                name:
                  type: string
                is_elation_group:
                  type: boolean
                users:
                  type: array
                  items:
                    type: integer
                    format: int64
                practice:
                  type: integer
                  format: int64
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"id\": 140754688737550,\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\ndata = {\n       'id': 140754688737550,   \n       'name': 'group,         \n       'is_elation_group': False, \n       'users': [\n         140754687361026,\n         140754687361027\n       ], \n       'practice': 211,\n}\nresp = requests.put(\"https://sandbox.elationemr.com/api/2.0/staff_groups/140754688737550\",\n                    data=json.dumps(data),\n                    headers={'Authorization': auth_header})\n\nprint(resp.status_code)\nprint(json.dumps(json.loads(resp.content), indent=2))"
        samples-languages:
        - python
      tags:
      - Staff Groups
      security:
      - sec0: []
    servers:
    - url: https://sandbox.elationemr.com/api/2.0
  /api/2.0/staff_groups/:
    get:
      operationId: staff_groups_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/PaginatedStaffGroupList'
          description: ''
      security:
      - oauth2: []
      summary: List Staff Groups
      tags:
      - Staff Groups
      x-el8-docs-category: Practice API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    post:
      description: Create a new staff group.
      operationId: staff_groups_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaffGroup'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaffGroup'
          description: ''
      security:
      - oauth2: []
      summary: Create Staff Group
      tags:
      - Staff Groups
      x-el8-docs-category: Practice 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/staff_groups/{id}/:
    delete:
      description: Delete an existing staff group.
      operationId: staff_groups_destroy
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '204':
          description: No response body
      security:
      - oauth2: []
      summary: Delete Staff Group
      tags:
      - Staff Groups
      x-el8-docs-category: Practice API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    get:
      operationId: staff_groups_retrieve
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaffGroup'
          description: ''
      security:
      - oauth2: []
      summary: Retrieve Staff Group
      tags:
      - Staff Groups
      x-el8-docs-category: Practice API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    patch:
      description: Update an existing staff group.
      operationId: staff_groups_partial_update
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedStaffGroup'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaffGroup'
          description: ''
      security:
      - oauth2: []
      summary: Partially Update Staff Group
      tags:
      - Staff Groups
      x-el8-docs-category: Practice API
      x-el8-docs-versions:
      - '2.1'
      - '2.0'
    put:
      description: Replace an existing staff group.
      operationId: staff_groups_update
      parameters:
      - in: path
        name: id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StaffGroup'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaffGroup'
          description: ''
      security:
      - oauth2: []
      summary: Update Staff Group
      tags:
      - Staff Groups
      x-el8-docs-category: Practice 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:
    StaffGroup:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        id:
          readOnly: true
          type: integer
        is_elation_group:
          description: Whether the staff group is an Elation group.
          type: boolean
        name:
          description: The name of the staff group.
          maxLength: 50
          type: string
        practice:
          description: The id of the practice that the staff group belongs to.
          format: int64
          type: integer
        users:
          description: A list of user ids inside the group.
          items:
            type: integer
          type: array
      required:
      - name
      - practice
      - users
      type: object
    PaginatedStaffGroupList:
      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/StaffGroup'
          type: array
      required:
      - results
      type: object
    PatchedStaffGroup:
      properties:
        created_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        deleted_date:
          format: date-time
          readOnly: true
          type:
          - string
          - 'null'
        id:
          readOnly: true
          type: integer
        is_elation_group:
          description: Whether the staff group is an Elation group.
          type: boolean
        name:
          description: The name of the staff group.
          maxLength: 50
          type: string
        practice:
          description: The id of the practice that the staff group belongs to.
          format: int64
          type: integer
        users:
          description: A list of user ids inside the group.
          items:
            type: integer
          type: array
      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