Health check (v1) | NapX PMS Docs

Documentation Get a single access code (without plain PIN)Get the PIN for an access code Activity Logs Controller_find All_v1 Create a new API key — full key is returned once and cannot be retrieved again List API keys for the current tenant Revoke an API key immediately App Controller_get Hello_v1 Auth Controller_check Tenant Slug Availability_v1 Auth Controller_login_v1 Auth Controller_logout_v1 Auth Controller_onboarding_v1 Auth Controller_register_v1 Auth Controller_reset Password_v1 Availability Restrictions Controller_create_v1 Availability Restrictions Controller_deactivate_v1 Availability Restrictions Controller_find Active_v1 Availability Restrictions Controller_find One_v1 Availability Restrictions Controller_remove_v1 Availability Restrictions Controller_update_v1 Companies Controller_create_v1 Companies Controller_find All_v1 Companies Controller_find One_v1 Companies Controller_remove_v1 Companies Controller_update_v1 Coupons Controller_create_v1 Coupons Controller_find All_v1 Coupons Controller_find One_v1 Coupons Controller_remove_v1 Coupons Controller_update_v1 External Access Codes Controller_get Guest Codes_v1 External Availability Controller_get Availability_v1 External Coupons Controller_find All_v1 External Coupons Controller_preview_v1 External Guests Controller_attach File_v1 External Guests Controller_create_v1 External Guests Controller_find All_v1 External Guests Controller_find One_v1 External Pricing Controller_get Price Quote_v1 External Products Controller_get Product_v1 External Products Controller_list Products_v1 External Rate Plans Controller_list Rate Plans_v1 External Reservations Controller_add Note_v1 External Reservations Controller_add Product_v1 External Reservations Controller_attach File_v1 External Reservations Controller_cancel_v1 External Reservations Controller_check In_v1 External Reservations Controller_check Out_v1 External Reservations Controller_confirm_v1 External Reservations Controller_create_v1 External Reservations Controller_create Payment Intent_v1 External Reservations Controller_find All_v1 External Reservations Controller_find One_v1 External Reservations Controller_get File Upload Url_v1 External Reservations Controller_list Notes_v1 External Reservations Controller_list Products_v1 External Reservations Controller_record Payment_v1 External Spaces Controller_find All_v1 External Space Types Controller_find All_v1 External Space Types Controller_find One_v1 Files Controller_attach_v1 Files Controller_delete Attachment_v1 Files Controller_delete File_v1 Files Controller_get Attachments_v1 Files Controller_get Presigned Url_v1 Files Controller_request Public Upload Url_v1 Files Controller_request Upload Url_v1 Files Controller_upload_v1 Folios Controller_close Folio_v1 Folios Controller_find All_v1 Folios Controller_find By Reservation_v1 Folios Controller_find One_v1 Guests Controller_create_v1 Guests Controller_create Note_v1 Guests Controller_delete Document_v1 Guests Controller_delete Note_v1 Guests Controller_find All_v1 Guests Controller_find One_v1 Guests Controller_get Document Url_v1 Guests Controller_get Notes_v1 Guests Controller_get Payment Methods_v1 Guests Controller_get Profile_v1 Guests Controller_link Attachment_v1 Guests Controller_list Attachments_v1 Guests Controller_list Documents_v1 Guests Controller_remove_v1 Guests Controller_request Document Upload Url_v1 Guests Controller_search_v1 Guests Controller_update_v1 Guests Controller_update Document_v1 Guests Controller_upload Document_v1 Health check Health check (v1)Add a Seam device to a property Create an access code on a device Delete an access code from a device List lock devices for the tenant enriched with real-time Seam status Get a single lock device List ALL devices visible in the Seam connected account, each annotated with their current PMS assignment (lockDeviceId / propertyId). Use this to build an Add / Remove device UI.List access codes for a device Lock a device Remove a device from this property (soft-delete)Mark or unmark a device as visible to all guests (building-level). shared=true removes room assignments and creates a spaceId=null record. shared=false removes the spaceId=null record so rooms can be assigned.Re-sync lock devices from Seam Unlock a device Update a lock device (assign space, set label)Update an access code on a device Notifications Controller_find All_v1 Notifications Controller_get Preferences_v1 Notifications Controller_set Preference_v1 Products Controller_create_v1 Products Controller_find All For Property_v1 Products Controller_find One_v1 Products Controller_remove_v1 Products Controller_update_v1 Properties Controller_create_v1 Properties Controller_find All_v1 Properties Controller_find One_v1 Properties Controller_remove_v1 Properties Controller_update_v1 Property Tax Rates Controller_create_v1 Property Tax Rates Controller_find All For Property_v1 Property Tax Rates Controller_remove_v1 Property Tax Rates Controller_update_v1 Rate Plans Controller_add Entry_v1 Rate Plans Controller_create_v1 Rate Plans Controller_find All_v1 Rate Plans Controller_find All For Property_v1 Rate Plans Controller_find Entries_v1 Rate Plans Controller_find One_v1 Rate Plans Controller_remove_v1 Rate Plans Controller_remove Entry_v1 Rate Plans Controller_update_v1 Rate Plans Controller_update Entry_v1 Reports Controller_get Manager Report_v1 List access codes for a reservation Get currently-valid guest-facing access codes for a reservation. Queries Seam live for codes on room devices and shared (building-level) devices. Only returns codes with status="set", effective now, and name not containing "staff". Returns [] when no devices are linked or no valid codes exist.Retry failed access code provisioning for a reservation Reservation Products Controller_add Product_v1 Reservation Products Controller_list Reservation Products_v1 Reservation Products Controller_remove Product_v1 Reservations Controller_add Product_v1 Reservations Controller_apply Coupon_v1 Reservations Controller_cancel_v1 Reservations Controller_charge Card On File_v1 Reservations Controller_check Availability_v1 Reservations Controller_check In_v1 Reservations Controller_check Out_v1 Reservations Controller_confirm_v1 Reservations Controller_create_v1 Reservations Controller_create Note_v1 Reservations Controller_create Payment Intent_v1 Reservations Controller_create Payment Link_v1 Reservations Controller_delete Note_v1 Reservations Controller_find All_v1 Reservations Controller_find One_v1 Reservations Controller_get Arrivals_v1 Reservations Controller_get Dashboard Metrics_v1 Reservations Controller_get Departures_v1 Reservations Controller_get Notes_v1 Reservations Controller_get Staying_v1 Reservations Controller_no Show_v1 Reservations Controller_remove_v1 Reservations Controller_remove Coupon_v1 Reservations Controller_search_v1 Reservations Controller_send Checkin Instructions_v1 Reservations Controller_send Invoice_v1 Reservations Controller_transition_v1 Reservations Controller_update_v1 Reservations Sse Controller_stream Reservations_v1 Roles Controller_find All_v1 Rooms Controller_create_v1 Rooms Controller_find All_v1 Rooms Controller_find One_v1 Rooms Controller_remove_v1 Rooms Controller_update_v1 Save Seam connected account ID and trigger device sync Create a Seam Connect Webview for operator onboarding Poll Connect Webview status Space Blocks Controller_create_v1 Space Blocks Controller_find All_v1 Space Blocks Controller_remove_v1 Spaces Controller_create_v1 Add a manual access code to a space Remove a manual access code from a space Spaces Controller_find All_v1 Spaces Controller_find One_v1 List manual access codes for a space Spaces Controller_remove_v1 Spaces Controller_update_v1 Spaces Controller_update Status_v1 Space Types Controller_create_v1 Space Types Controller_find All_v1 Space Types Controller_find One_v1 Space Types Controller_remove_v1 Space Types Controller_update_v1 Tasks Controller_create_v1 Tasks Controller_find All_v1 Tasks Controller_update Status_v1 Tenants Controller_get Current_v1 Transactions Controller_accounting_v1 Transactions Controller_capture_v1 Transactions Controller_create_v1 Transactions Controller_find All_v1 Transactions Controller_find One_v1 Transactions Controller_refund_v1 Transactions Controller_resend Payment Link_v1 Transactions Controller_void_v1 Users Controller_create_v1 Users Controller_delete_v1 Users Controller_find All_v1 Users Controller_find One_v1 Users Controller_get Me_v1 Users Controller_invite_v1 Users Controller_resend Invite_v1 Users Controller_update_v1 Users Controller_update Me_v1

GET

/v1/health

Response Body

`application/json`

curl -X GET "https://example.com/v1/health"

{
  "data": {
    "status": "ok",
    "timestamp": "2026-03-19T16:42:16.833Z"
  }
}