Provider Directory API Documentation
Version 1.0
API Walkthrough
PostMan Collection
Download the Postman collection, import it into Postman. If you need help importing, click on button below to see Postman’s guide.
Overview
The Provider Directory API enables programmatic access to comprehensive healthcare provider and facility data. This documentation details the API endpoints, request/response formats, and integration guidelines. The API follows RESTful principles and uses JSON for data exchange.
API Collections
The Provider Directory API is organized into three main collections:
- Lookup: Reference data and code lists
- Site: Healthcare facility and location information
- Provider: Healthcare provider details and credentials
Lookup Collection
The Lookup collection provides access to standardized reference data used throughout the Provider Directory system. These endpoints return code lists and lookup values essential for data validation and display.
Available Endpoints
| Endpoint | Description | Try It |
|---|---|---|
/v1/Lookup/schedule-codes |
Provider schedules and availability codes | Live Demo |
/v1/Lookup/facility-types |
Healthcare facility classification codes | Live Demo |
/v1/Lookup/service-codes |
Available healthcare services | Live Demo |
/v1/Lookup/population-served-codes |
Target population demographics | Live Demo |
/v1/Lookup/licensure-codes |
Professional licensure types | Live Demo |
/v1/Lookup/state-codes |
US state and territory codes | Live Demo |
/v1/Lookup/gender-codes |
Gender identity codes | Live Demo |
/v1/Lookup/taxonomy |
Healthcare provider taxonomy codes | Live Demo |
/v1/Lookup/language-codes |
Supported languages | Live Demo |
/v1/Lookup/cultural-cap-codes |
Cultural competency indicators | Live Demo |
/v1/Lookup/specialties |
Medical specialties | Live Demo |
/v1/Lookup/telehealths |
Telehealth service options | Live Demo |
Provider Collection
The Provider Collection enables you to search and filter providers, access provider details, languages, and specialties through a set of RESTful endpoints.
Available Endpoints
| Endpoint | Description | Try It |
|---|---|---|
/v1/Provider/providers |
Returns a paginated list of providers. Query parameters:
|
Live Demo |
/v1/Provider/search |
Search providers using optional filters. Omit a parameter or pass it empty to ignore that filter. Query parameters:
Notes:
|
Live Demo |
/v1/Provider/{providerId} |
Get detailed information for a specific provider. Path parameter:
Query parameters: None. |
Live Demo |
/v1/Provider/provider-languages |
Get list of supported provider languages with fluency levels. Query parameters: None. |
Live Demo |
/v1/Provider/provider-types-list |
Get list of provider with related taxonomy codes. Query parameters: None. |
Live Demo |
Site Collection
The Site Collection provides access to healthcare facility information, including locations, services, and schedules. These endpoints enable you to search facilities, retrieve detailed site information, and access related provider associations.
The collection includes endpoints for retrieving site details, searching facilities with various filters, accessing schedules, and managing provider-site relationships. Additional utility endpoints provide quick access to site names and address information.
Available Endpoints
| Endpoint | Description | Try It |
|---|---|---|
/v1/Site/sites |
Returns a paginated list of providers. Query parameters:
|
Live Demo |
/v1/Site/{siteId} |
Get detailed information for a specific site. Path parameter:
Query parameters: None. |
Live Demo |
/v1/Site/search |
Search sites using optional filters. Omit a parameter or pass it empty to ignore that filter. Query parameters (all optional unless noted):
|
Live Demo |
/v1/Site/site-schedule/{siteId} |
Return the schedule that a specific site opens and closes. Path parameter:
Query parameters: None. |
Live Demo |
/v1/Site/provider-site/{siteId} |
Get provider-site relationship data for a specific site. Returns data from the junction table that links providers to sites, showing which providers are associated with the specified site. Path parameter:
Query parameters: None. |
Live Demo |
/v1/Site/all-site-names |
Get a list of all site names in the system. Returns a simple list of site names, useful for populating dropdowns or autocomplete fields. Path parameters: None. Query parameters: None. |
Live Demo |
/v1/Site/all-site-address |
Get a list of all site addresses in the system. This endpoint returns the street address only. Returns address information for all sites, useful for location-based searches and mapping functionality. Path parameters: None. Query parameters: None. |
Live Demo |
/v1/Site/all-site-address2 |
Get an alternative format of all site addresses including building, office, suite information. Returns secondary address details (building, office, suite numbers) for all sites in the system. This endpoint does not include the street address. Path parameters: None. Query parameters: None. |
Live Demo |

