VA Lighthouse Facilities API is one of 36 APIs that Department of Veterans Affairs (VA Lighthouse) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Facilities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, and authentication docs.
This API exposes
8 operations
across 8 paths,
and defines 74 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://sandbox-api.va.gov/services/va_facilities/{version}, https://api.va.gov/services/va_facilities/{version}.
The identity and technical contract details declared by the specification.
Properties
objectnull
Details describing a facility.
18 properties
3 required
ApiError
object
API invocation or processing error
1 property
1 required
DetailedServiceAddress
objectnull
Service location address.
8 properties
GeoFacilityReadResponse
object
Response that contains GeoFacility data.
3 properties
3 required
NearbyAttributes
objectnull
2 properties
2 required
Services
objectnull
All services offered by a VA health or benefits facility grouped by service type.
4 properties
GeoFacilitiesResponse
object
GeoJSON API-compliant response object describing one or more VA facilities.
2 properties
1 required
Pagination
object
Pagination data reflecting response that has been seperated into discrete pages.
4 properties
4 required
ErrorMessage
object
4 properties
PageLinks
object
Links for first page, next page, previous and last page of response.
6 properties
1 required
SupplementalStatus
objectnull
Supplemental status for VA facility.
2 properties
2 required
DetailedServiceLocation
objectnull
Details for a location offering a service.
9 properties
AppointmentPhoneNumber
objectnull
Phone number information for scheduling an appointment.
4 properties
DetailedService
objectnull
Detailed information of a facility service.
11 properties
Phone
objectnull
Collection of all telephone contact numbers for given facility.
8 properties
Distance
object
Distance to facility in miles using decimal format. Used when querying for facilities proximal to a location.
2 properties
2 required
WaitTimes
objectnull
Collection of wait times reported for various services based on access to care survey.
2 properties
Satisfaction
objectnull
Scores that indicate patient satisfaction at given facility per service.
2 properties
FacilitiesResponse
object
JSON API-compliant response object describing one or more VA facilities
3 properties
2 required
Hours
objectnull
Standard hours of operation. Currently formatted as descriptive text suitable for display, with no guarantee of a standard parseable format. Hours of operation…
7 properties
OperatingStatus
objectnull
Current status of facility operations. The overall status of the facility, which can be: Normal Hours and Services, Facility Notice, Limited Hours and/or Servi…
3 properties
1 required
Geometry
objectnull
Geometric data giving the physical location of a VA Facility.
2 properties
1 required
FacilitiesMetadata
object
Metadata representation for data in response. This metadata includes paginated items that allow user to see the current page, objects perPage, total pages and…
2 properties
1 required
GenericError
object
A general error json response for things like Authorization Errors or Bad Requests (ex. invalid parameter values).
1 property
1 required
NearbyResponse
objectnull
Response which contains minimum and maximum time it takes to reach facility.
2 properties
Meta
objectnull
JSON API-compliant object containing metadata about this response.
1 property
GeoFacility
object
GeoJSON-complaint Feature object describing a VA Facility
3 properties
3 required
FacilityReadResponse
object
Response that contains facility data.
1 property
1 required
DetailedServiceHours
objectnull
Standard hours of operation. Currently formatted as descriptive text suitable for display, with no guarantee of a standard parseable format. Hours of operation…
7 properties
Addresses
objectnull
Collection of addresses associated with a facility.
2 properties
DetailedServiceEmailContact
objectnull
Email contact information for facility service.
2 properties
FacilityAttributes
objectnull
Details describing a facility.
19 properties
5 required
PatientSatisfaction
objectnull
Veteran-reported satisfaction score for health care services at VA health facilities.
4 properties
Facility
object
JSON API representation of a Facility.
3 properties
3 required
Nearby
objectnull
JSON API-compliant object describing a nearby VA facility.
3 properties
3 required
PatientWaitTime
objectnull
Expected wait times for new and established patients for a given health care service at VA health facilities.
3 properties
1 required
Address
objectnull
Description of an address.
6 properties
FacilitiesIdsResponse
object
JSON API response for a query for facility ids.
1 property
ApiError_2
object
API invocation or processing error
1 property
DetailedServiceAddress_2
objectnull
Service location address.
8 properties
NearbyAttributes_2
objectnull
2 properties
Services_2
objectnull
All services offered by a VA facility grouped by service type.
5 properties
Parent
objectnull
Reference to facility's parent
2 properties
Pagination_2
object
Pagination data reflecting response that has been seperated into discrete pages.
4 properties
DetailedServicesResponse
object
An object containing a list of services.
3 properties
PageLinks_2
object
Links for first page, next page, previous and last page of response.
6 properties
DetailedServiceLocation_2
objectnull
Details for a location offering a service.
9 properties
Phone_2
objectnull
Collection of all telephone contact numbers for given facility.
8 properties
DetailedService_2
objectnull
Detailed information of a facility service.
9 properties
Distance_2
object
Distance to facility in miles using decimal format. Used when querying for facilities proximal to a location.
2 properties
ServiceInfo
object
Service information.
3 properties
Satisfaction_2
objectnull
Scores that indicate patient satisfaction at given facility per service.
2 properties
FacilitiesResponse_2
object
An object describing one or more VA facilities
3 properties
OperatingStatus_2
objectnull
Current status of facility operations. The overall status of the facility, which can be: Normal Hours and Services, Facility Notice, Limited Hours and/or Servi…
3 properties
1 required
DetailedServiceResponse
object
Expanded details for a service.
1 property
ServiceHealthService
object
Service info block.
3 properties
ServiceOtherService
object
Service info block.
3 properties
FacilitiesMetadata_2
object
Metadata representation for data in response. This metadata includes paginated items that allow user to see the current page, objects perPage, total pages and…
2 properties
GenericError_2
object
A general error json response for things like Authorization Errors or Bad Requests (ex. invalid parameter values).
1 property
NearbyResponse_2
objectnull
Object containing minimum and maximum time it takes to reach a facility.
2 properties
Meta_2
objectnull
Object containing metadata about this response.
1 property
ServiceBenefitsService
object
Service info block.
3 properties
FacilityReadResponse_2
object
An object containing facility data.
1 property
DetailedServiceHours_2
objectnull
Standard hours of operation. Currently formatted as descriptive text suitable for display, with no guarantee of a standard parseable format. Hours of operation…
7 properties
FacilityAttributes_2
objectnull
Details describing a facility.
18 properties
1 required
DetailedServiceEmailContact_2
objectnull
Email contact information for facility service.
2 properties
PatientSatisfaction_2
objectnull
Veteran-reported satisfaction score for health care services at VA health facilities.
4 properties
HealthCareSystem
objectnull
Health Care System of the facility
1 property
Facility_2
object
Representation of a Facility.
3 properties
Nearby_2
objectnull
Object describing a nearby VA facility.
3 properties
PatientWaitTime_2
objectnull
Expected wait times for new and established patients for a given health care service at VA health facilities.
3 properties
DetailedServicesMetadata
object
Object containing metadata about detailed service response
1 property
Address_2
objectnull
Description of an address.
6 properties
FacilitiesIdsResponse_2
object
A list of facility ids.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Department of Veterans Affairs (VA Lighthouse) publishes across the network.
