Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Locations

Retrieve a single location by ID

Returns a single location record identified by {id}, scoped to the tenant identified by the required tenant-id header.

When to use: Use when you already know the location's ID and need its full detail. To list all locations for a tenant use GET /locations.

Preconditions: The tenant-id header is required. The {id} path parameter accepts either the location's certifyLocationId or its crosswalkId — it is looked up by certifyLocationId first, falling back to crosswalkId if no match is found.

get/locations/{id}

Path parameters

idstring required

The location's certifyLocationId or crosswalkId.

Headers

tenant-idstring

Response

A LocationResponse object containing the location's identifiers and detail fields (contacts, service address attributes, accessibility, office hours, practice limitations sourced from the location's operational value).

idstring
crosswalkIdstring
entityAddressIdstring
tenantIdstring
hoursOfOperationobject[]
languagesobject[]
specialitiesobject[]
certificationsobject[]
networkAffiliationsobject[]
facilityTypesobject[]
paymentOptionsobject[]
accessibilityOptionsobject[]
practiceLimitationsobject[]
otherAttributesobject[]
identifiersobject[]
notesobject[]
billingEffectiveDatestring date-time
billingTerminationDatestring date-time
effectiveDatestring date-time
terminationDatestring date-time

Example response

{
  "billingEffectiveDate": "2022-03-10T16:15:50Z",
  "billingTerminationDate": "2022-03-10T16:15:50Z",
  "effectiveDate": "2022-03-10T16:15:50Z",
  "terminationDate": "2022-03-10T16:15:50Z"
}