August Health Census (v1) API

openapi: 3.2.0
info:
  title: August Health Integrations Census (v1) API
  version: '1.0'
servers:
- url: https://integrations.staging.augusthealth.com
security:
- BearerAuth: []
tags:
- name: Census (v1)
paths:
  /v1/organizations/{orgId}/facilities/{facilityId}/census:
    get:
      description: Lists limited demographic information for people within a facility
      operationId: listCensusV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        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
      - in: query
        name: residentStatus
        required: false
        schema:
          $ref: '#/components/schemas/com.august.protos.person.ResidentStatus'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.CensusPerson'
                    type: array
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Successfully listed people.
        '401':
          description: No credentials provided
        '403':
          description: Not Authorized for this resource
      summary: List Census
      tags:
      - Census (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/census/{personId}:
    get:
      description: Get limited demographic information for a specific person within a facility
      operationId: getCensusPersonV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.CensusPerson'
                type: object
          description: Successfully retrieved the person.
        '401':
          description: No credentials provided
        '403':
          description: Not Authorized for this resource
        '404':
          description: Resource not found
      summary: Get Census Person
      tags:
      - Census (v1)
components:
  schemas:
    com.august.api.integrations.models.people.v1.ExternalFields:
      properties:
        caregroveResidentId:
          description: The person's resident ID in CareGrove
          type: string
        eldermarkResidentId:
          description: The person's resident ID in Eldermark
          type: string
        realpageResidentId:
          description: The person's resident ID in RealPage
          type: string
        welcomeHomeResidentId:
          description: The person's resident ID in WelcomeHome
          type: string
        yardiResidentId:
          description: The person's resident ID in Yardi
          type: string
    com.august.protos.address.Address.AddressUse:
      enum:
      - ADDRESS_USE_HOME
      - ADDRESS_USE_WORK
      - ADDRESS_USE_TEMP
      - ADDRESS_USE_OLD
      - ADDRESS_USE_BILLING
      type: string
    com.august.api.integrations.models.census.v1.CensusRoom:
      properties:
        externalId:
          description: The room's ID in the external system that manages the facility's rooms
          type: string
        id:
          description: The room ID
          type: string
        name:
          description: The room name
          type: string
      required:
      - id
    com.august.protos.person.ResidentStatus:
      enum:
      - RESIDENT_STATUS_PROSPECT
      - RESIDENT_STATUS_CURRENT_RESIDENT
      - RESIDENT_STATUS_CLOSED
      - RESIDENT_STATUS_DISCHARGED
      - RESIDENT_STATUS_ENTERED_IN_ERROR
      type: string
    com.august.protos.gender.Gender:
      enum:
      - GENDER_NON_BINARY
      - GENDER_FEMALE
      - GENDER_MALE
      type: string
    com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentType:
      enum:
      - ASSESSMENT_TYPE_SUPERVISORY_CARE
      - ASSESSMENT_TYPE_PERSONAL_CARE
      - ASSESSMENT_TYPE_DIRECTED_CARE
      - ASSESSMENT_TYPE_DIRECTED_CARE_MEMORY_SERVICES
      - ASSESSMENT_TYPE_SPECIAL_CARE_RESIDENT
      - ASSESSMENT_TYPE_TRADITIONAL_RESIDENT
      type: string
    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.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.protos.human_name.HumanName.Pronouns:
      enum:
      - PRONOUNS_SHE_HER
      - PRONOUNS_HE_HIM
      - PRONOUNS_THEY_THEM
      - PRONOUNS_SHE_THEY
      - PRONOUNS_HE_THEY
      - PRONOUNS_ZE_HIR
      type: string
    com.august.api.integrations.models.census.v1.CensusOutOfFacility:
      properties:
        start:
          description: When the resident left the facility
          format: date-time
          type: string
      required:
      - start
    com.august.api.integrations.models.census.v1.CensusLevelOfCare:
      properties:
        assessmentType:
          $ref: '#/components/schemas/com.august.protos.settings.appraisal_settings.AppraisalSettings.AssessmentType'
        levelName:
          type: string
        score:
          format: int32
          type: integer
        value:
          format: int32
          type: integer
    com.august.api.integrations.models.census.v1.FutureBedAssignment:
      properties:
        bed:
          $ref: '#/components/schemas/com.august.api.integrations.models.common.Bed'
          description: The bed the resident will move to
        effectiveDate:
          example: '2020-01-01'
          format: date
          type: string
        room:
          $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.CensusRoom'
          description: The room the resident will move to
      required:
      - effectiveDate
      - room
    com.august.protos.person.Person.MaritalStatus:
      enum:
      - MARITAL_STATUS_MARRIED
      - MARITAL_STATUS_DIVORCED
      - MARITAL_STATUS_WIDOWED
      - MARITAL_STATUS_SINGLE
      - MARITAL_STATUS_SEPARATED
      - MARITAL_STATUS_DOMESTIC_PARTNER
      type: string
    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
    com.august.api.integrations.models.common_metadata.v1.Address:
      properties:
        city:
          type: string
        line:
          items:
            type: string
          type: array
        postalCode:
          type: string
        state:
          type: string
        text:
          type: string
        use:
          $ref: '#/components/schemas/com.august.protos.address.Address.AddressUse'
      required:
      - line
    com.august.protos.snapshot.Polst.CPR:
      enum:
      - CPR_ATTEMPT_RESUSCITATION
      - CPR_DO_NOT_ATTEMPT_RESUSCITATION
      type: string
    com.august.api.integrations.models.common_metadata.v1.HumanName:
      properties:
        family:
          type: string
        given:
          items:
            type: string
          type: array
        maiden:
          type: string
        preferredName:
          type: string
        prefix:
          type: string
        pronouns:
          $ref: '#/components/schemas/com.august.protos.human_name.HumanName.Pronouns'
        suffix:
          type: string
      required:
      - given
    com.august.api.integrations.models.census.v1.CensusPerson:
      properties:
        address:
          $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.Address'
          description: The person's address (prior to admission)
        admissionType:
          $ref: '#/components/schemas/com.august.protos.admissions.AdmissionsInformation.AdmissionType'
          description: The type of care the resident is admitted for
        bed:
          $ref: '#/components/schemas/com.august.api.integrations.models.common.Bed'
          description: The person's current bed assignment
        birthdate:
          example: '2020-01-01'
          format: date
          type: string
        cprCode:
          $ref: '#/components/schemas/com.august.protos.snapshot.Polst.CPR'
          description: The person's CPR code (permission-gated; only included when the caller has the census CPR code read permission)
        email:
          description: The person's email address
          type: string
        externalFields:
          $ref: '#/components/schemas/com.august.api.integrations.models.people.v1.ExternalFields'
          description: The person's IDs in external systems
        facilityId:
          description: The facility ID
          type: string
        financialMoveOutDate:
          example: '2020-01-01'
          format: date
          type: string
        financialStartDate:
          example: '2020-01-01'
          format: date
          type: string
        futureBedAssignment:
          $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.FutureBedAssignment'
          description: The person's scheduled future room/bed transfer, if one exists
        gender:
          $ref: '#/components/schemas/com.august.protos.gender.Gender'
          description: The person's gender
        id:
          description: The person's ID
          type: string
        levelOfCare:
          $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.CensusLevelOfCare'
          description: The person's level of care (permission-gated; only included when the caller has the census care level read permission)
        maritalStatus:
          $ref: '#/components/schemas/com.august.protos.person.Person.MaritalStatus'
          description: The person's marital status
        moveInStartDate:
          example: '2020-01-01'
          format: date
          type: string
        moveOutDate:
          example: '2020-01-01'
          format: date
          type: string
        name:
          $ref: '#/components/schemas/com.august.api.integrations.models.common_metadata.v1.HumanName'
          description: The person's name
        orgId:
          description: The organization ID
          type: string
        outOfFacility:
          $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.CensusOutOfFacility'
          description: Present when the resident is currently away from the facility (e.g., hospitalized, on leave). Absent when the resident is in-facility. The reason is intentionally omitted as protected health information; use the person endpoint to retrieve it.
        phone:
          description: The person's primary phone number
          type: string
        religiousPreference:
          description: The person's religious preference
          type: string
        residentStatus:
          $ref: '#/components/schemas/com.august.protos.person.ResidentStatus'
          description: The person's resident status
        room:
          $ref: '#/components/schemas/com.august.api.integrations.models.census.v1.CensusRoom'
          description: The person's current room assignment
      required:
      - id
      - orgId
      - facilityId
      - name
      - residentStatus
  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