August Health Visitor Logs (v1) API

openapi: 3.2.0
info:
  title: August Health Integrations Visitor Logs (v1) API
  version: '1.0'
servers:
- url: https://integrations.staging.augusthealth.com
security:
- BearerAuth: []
tags:
- name: Visitor Logs (v1)
paths:
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/visitorLogs:
    get:
      description: Returns a paginated list of non-deleted visitor log entries for the resident, sorted by sign-in time descending.
      operationId: listVisitorLogsV1
      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
      - description: Comma-separated list of fields to include in the response
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: Maximum number of results to return
        in: query
        name: limit
        required: false
        schema:
          default: 100
          format: int32
          maximum: 500
          type: integer
      - description: Number of results to skip
        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.visitor_logs.v1.VisitorLogResponse'
                    type: array
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Successfully retrieved visitor log entries.
        '400':
          description: Invalid request parameters (e.g., limit exceeds 500)
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to read visitor log entries for this person
      summary: List visitor log entries for a resident
      tags:
      - Visitor Logs (v1)
    post:
      description: Records a sign-in for a visitor of a resident. The request may optionally include sign-out information if the visit has already ended.
      operationId: createVisitorLogV1
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.august.api.integrations.models.visitor_logs.v1.CreateVisitorLogRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.visitor_logs.v1.VisitorLogResponse'
                type: object
          description: Successfully created a new visitor log entry.
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to create visitor log entries for this person
        '404':
          description: Person not found
      summary: Create a visitor log entry
      tags:
      - Visitor Logs (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/visitorLogs/{id}:
    delete:
      description: Marks a visitor log entry as deleted. Soft-deleted entries are excluded from list responses.
      operationId: deleteVisitorLogV1
      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
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted the visitor log entry.
        '401':
          description: Authentication required
        '403':
          description: User lacks permission to delete visitor log entries for this person
        '404':
          description: Visitor log entry or person not found
      summary: Soft-delete a visitor log entry
      tags:
      - Visitor Logs (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.visitor_logs.v1.VisitorLogSignOutResponse:
      properties:
        comments:
          description: Visitor-provided comments.
          type: string
        durationMinutes:
          description: Visit duration in minutes, if recorded.
          format: int32
          type: integer
        rating:
          description: Visitor-provided rating.
          format: double
          type: number
        signoutAt:
          description: The instant the visitor signed out.
          format: date-time
          type: string
      required:
      - signoutAt
    com.august.api.integrations.models.visitor_logs.v1.VisitorLogResponse:
      properties:
        companyName:
          description: Company associated with the visitor, if applicable.
          type: string
        id:
          description: The visitor log entry's ID.
          type: string
        personId:
          description: The resident's ID.
          type: string
        signOut:
          $ref: '#/components/schemas/com.august.api.integrations.models.visitor_logs.v1.VisitorLogSignOutResponse'
          description: Sign-out information, populated once the visit ends.
        signinAt:
          description: The instant the visitor signed in.
          format: date-time
          type: string
        visitId:
          description: External identifier that uniquely identifies the visit across systems.
          type: string
        visitType:
          description: Free-form description of the visit (e.g., "social", "medical", "delivery").
          type: string
        visitorName:
          description: Visitor's name, if recorded.
          type: string
        visitorPhone:
          description: Visitor's phone number, if recorded.
          type: string
        visitorType:
          description: Category of the visitor (e.g., "Family/Friends").
          type: string
      required:
      - id
      - personId
      - visitId
      - visitType
      - signinAt
    com.august.api.integrations.models.visitor_logs.v1.CreateVisitorLogSignOutRequest:
      properties:
        comments:
          description: Visitor-provided comments.
          type: string
        durationMinutes:
          description: Visit duration in minutes.
          format: int32
          type: integer
        rating:
          description: Visitor-provided rating.
          format: double
          type: number
        signoutAt:
          description: The instant the visitor signed out.
          format: date-time
          type: string
      required:
      - signoutAt
    com.august.api.integrations.models.visitor_logs.v1.CreateVisitorLogRequest:
      properties:
        companyName:
          description: Company associated with the visitor, if applicable.
          type: string
        signOut:
          $ref: '#/components/schemas/com.august.api.integrations.models.visitor_logs.v1.CreateVisitorLogSignOutRequest'
          description: Sign-out information, if the visit has already ended.
        signinAt:
          description: The instant the visitor signed in.
          format: date-time
          type: string
        visitId:
          description: External identifier that uniquely identifies the visit across systems.
          type: string
        visitType:
          description: Free-form description of the visit (e.g., "social", "medical", "delivery").
          type: string
        visitorName:
          description: Visitor's name, if recorded.
          type: string
        visitorPhone:
          description: Visitor's phone number, if recorded.
          type: string
        visitorType:
          description: Category of the visitor (e.g., "Family/Friends").
          type: string
      required:
      - visitId
      - visitType
      - signinAt
  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