August Health Facilities (v1) API

openapi: 3.2.0
info:
  title: August Health Integrations Facilities (v1) API
  version: '1.0'
servers:
- url: https://integrations.staging.augusthealth.com
security:
- BearerAuth: []
tags:
- name: Facilities (v1)
paths:
  /v1/organizations/{orgId}/facilities:
    get:
      description: List facilities visible to the current user in a given organization.
      operationId: listFacilitiesV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: query
        name: limit
        required: false
        schema:
          default: 100
          format: int32
          type: integer
      - in: query
        name: offset
        required: false
        schema:
          default: 0
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.facilities.v1.Facility'
                    type: array
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Successfully listed facilities.
      summary: List facilities
      tags:
      - Facilities (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/rooms:
    get:
      description: Returns all active rooms for the specified facility, including configured beds and market rates. Optionally filter by effective date.
      operationId: listRoomsV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: query
        name: effectiveDate
        required: false
        schema:
          example: '2020-01-01'
          format: date
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.rooms.v1.Room'
                    type: array
                type: object
          description: Successfully listed rooms.
      summary: List rooms for a facility
      tags:
      - Facilities (v1)
components:
  schemas:
    com.august.api.integrations.models.common.ApiResponseMetadata:
      properties:
        limit:
          description: The limit used for a paginated request for the query
          format: int32
          type: integer
        offset:
          description: The offset used for a paginated request for the query
          format: int32
          type: integer
        total:
          description: The total number of available items for the query
          format: int32
          type: integer
      required:
      - total
      - limit
      - offset
    com.august.api.integrations.models.facilities.v1.Facility:
      properties:
        id:
          type: string
        name:
          type: string
      required:
      - id
      - name
    com.august.protos.admissions.AdmissionsInformation.AdmissionType:
      enum:
      - ADMISSION_TYPE_ASSISTED_LIVING
      - ADMISSION_TYPE_MEMORY_CARE
      - ADMISSION_TYPE_INDEPENDENT_LIVING
      type: string
    com.august.api.integrations.models.common.Measurement:
      properties:
        unit:
          type: string
        value:
          format: double
          type: number
      required:
      - value
      - unit
    com.august.api.integrations.models.rooms.v1.Room:
      properties:
        admissionType:
          $ref: '#/components/schemas/com.august.protos.admissions.AdmissionsInformation.AdmissionType'
          description: The admission type assigned to this room.
        area:
          $ref: '#/components/schemas/com.august.api.integrations.models.common.Measurement'
          description: The room's floor area in square feet (permission-gated; only included when the caller has the room marketing read permission).
        beds:
          description: Configured beds for this room.
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.common.Bed'
            description: Configured beds for this room.
          type: array
        description:
          description: Free-form marketing description of the room (permission-gated; only included when the caller has the room marketing read permission).
          type: string
        externalId:
          description: The room's ID in the external system that manages the facility's rooms.
          type: string
        marketRates:
          description: Active market rates for this room (permission-gated; only included when the caller has the room marketing read permission).
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.rooms.v1.RoomMarketRate'
            description: Active market rates for this room (permission-gated; only included when the caller has the room marketing read permission).
          type: array
        roomId:
          description: Unique identifier for the room.
          type: string
        roomName:
          description: Human-readable name of the room.
          type: string
      required:
      - roomId
      - roomName
      - beds
    com.august.api.integrations.models.rooms.v1.RoomMarketRate:
      properties:
        admissionType:
          $ref: '#/components/schemas/com.august.protos.admissions.AdmissionsInformation.AdmissionType'
        endDate:
          example: '2020-01-01'
          format: date
          type: string
        occupancyType:
          enum:
          - PRIVATE
          - SHARED
          - SECOND_OCCUPANT
          type: string
        rateCents:
          format: int32
          type: integer
        startDate:
          example: '2020-01-01'
          format: date
          type: string
      required:
      - occupancyType
      - rateCents
      - startDate
    com.august.api.integrations.models.common.Bed:
      properties:
        externalId:
          description: The bed's ID in the external system that manages the facility's rooms and beds.
          type: string
        id:
          description: The bed's unique identifier.
          type: string
        name:
          description: The bed's display name. Empty for single-occupancy rooms; only populated when the room's occupancy is greater than 1.
          type: string
      required:
      - id
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
x-provenance:
  method: searched
  source: https://developer.augusthealth.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.augusthealth.com/reference/bulkchartroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/createcontactv1-1.md
  - https://developer.augusthealth.com/reference/createincidentv1.md
  - https://developer.augusthealth.com/reference/createpersonv1-1.md
  - https://developer.augusthealth.com/reference/createresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/createtokenv1.md
  - https://developer.augusthealth.com/reference/createvisitorlogv1.md
  - https://developer.augusthealth.com/reference/createvitalv1.md
  - https://developer.augusthealth.com/reference/createwebhooksportalaccessurlv1.md
  - https://developer.augusthealth.com/reference/deletevisitorlogv1.md
  - https://developer.augusthealth.com/reference/extractresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/getadmissionagreementpdfv1.md
  - https://developer.augusthealth.com/reference/getadmissionagreementv1.md
  - https://developer.augusthealth.com/reference/getadmissionhistoryv1.md
  - https://developer.augusthealth.com/reference/getassessmentv1.md
  - https://developer.augusthealth.com/reference/getbillingsummaryv1.md
  - https://developer.augusthealth.com/reference/getcensuspersonv1.md
  - https://developer.augusthealth.com/reference/getcontactv1-1.md
  - https://developer.augusthealth.com/reference/getfacilityadmissionhistoryv1.md
  - https://developer.augusthealth.com/reference/getfacilitybedassignmenthistoryv1.md
  - https://developer.augusthealth.com/reference/getimmunizationv1.md
  - https://developer.augusthealth.com/reference/getincidentv1.md
  - https://developer.augusthealth.com/reference/getlatestadmissionagreementv1.md
  - https://developer.augusthealth.com/reference/getlatestassessmentv1.md
  - https://developer.augusthealth.com/reference/getlatestresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/getpersonprofilephotov1.md
  - https://developer.augusthealth.com/reference/getpersonv1-1.md
  - https://developer.augusthealth.com/reference/getstatementpdfv1.md
  - https://developer.augusthealth.com/reference/getvitalv1.md
  - https://developer.augusthealth.com/reference/listbedassignmentsv1.md
  - https://developer.augusthealth.com/reference/listcensusv1.md
  - https://developer.augusthealth.com/reference/listcontactsv1-1.md
  - https://developer.augusthealth.com/reference/listfacilitiesv1-1.md
  - https://developer.augusthealth.com/reference/listfacilitybillingsummariesv1.md
  - https://developer.augusthealth.com/reference/listfacilityincidentsv1.md
  - https://developer.augusthealth.com/reference/listfacilitymedicationadministrationsv1.md
  - https://developer.augusthealth.com/reference/listfacilitymedicationordersv1.md
  - https://developer.augusthealth.com/reference/listfacilityroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/listimmunizationsv1.md
  - https://developer.augusthealth.com/reference/listmedpassesv1.md
  - https://developer.augusthealth.com/reference/listorganizationsv1.md
  - https://developer.augusthealth.com/reference/listpeoplev1-1.md
  - https://developer.augusthealth.com/reference/listpersonincidentsv1.md
  - https://developer.augusthealth.com/reference/listpersonmedicationadministrationsv1.md
  - https://developer.augusthealth.com/reference/listpersonmedicationordersv1.md
  - https://developer.augusthealth.com/reference/listprncarecategoriesv1.md
  - https://developer.augusthealth.com/reference/listresidentbillingtransactionsv1.md
  - https://developer.augusthealth.com/reference/listroomsv1.md
  - https://developer.augusthealth.com/reference/listroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/listshiftsv1.md
  - https://developer.augusthealth.com/reference/listtasksv1.md
  - https://developer.augusthealth.com/reference/listusersv1.md
  - https://developer.augusthealth.com/reference/listvisitorlogsv1.md
  - https://developer.augusthealth.com/reference/listvitalsv1.md
  - https://developer.augusthealth.com/reference/patchpersonv1.md
  - https://developer.augusthealth.com/reference/recordchargesv1.md
  - https://developer.augusthealth.com/reference/recorddepositv1.md
  - https://developer.augusthealth.com/reference/searchstatementsv1.md
  - https://developer.augusthealth.com/reference/setresponsiblepersonv1-1.md
  - https://developer.augusthealth.com/reference/updateincidentv1.md
  - https://developer.augusthealth.com/reference/updatevitalv1.md
  merge:
    pages: 61
    deduped: 634
    conflicts_kept_first: 0