Patient Scheduling API

Locations

Server

Query and download Labcorp patient service center locations, including inactive locations.


Download full location list

GET
https://scheduling.services.{domain}
/locations

Access the entire set of Labcorp locations in one large JSON array. While gzip compressed, this is over 2000 locations with their associated services, so this endpoint is intended only for preloading this data locally instead of using the location search endpoint.

Download full location list › Responses

ok

id
​integer
name
​string
​LocationAddress
​object[]
opensAt
​string

Optional field that indicates the general opening hour of the location.

Example: 08:00 AM
closesAt
​string

Optional field that indicates the general closing hour of the location.

Example: 05:00 PM
lunchStart
​string

Optional field that indicates the lunch start at the location.

Example: 12:00 PM
lunchEnd
​string

Optional field that indicates the lunch end at the location.

Example: 01:00 PM

Download inactive location list

GET
https://scheduling.services.{domain}
/locations/inactive

Return locations that were inactivated in the last 7 days if no query parameters are provided. If a date range is provided, it must be within 90 days; numberOfDays can also be used to adjust the window of inactivated locations returned.

Download inactive location list › query Parameters

startDate
​string · date · pattern: ^\d{4}-\d{2}-\d{2}$

Optional starting date for returned values. This value should be in the past by up to 90 days.

Example: 2019-01-24
endDate
​string · date · pattern: ^\d{4}-\d{2}-\d{2}$

Optional ending date for returned values.

Example: 2019-01-24
noOfDays
​integer · min: 1 · max: 90

Optional number of days. This value is between 1 and 90, with a default of 7.

Default: 7

Download inactive location list › Responses

ok

id
​integer
name
​string
​LocationAddress
​object[]
opensAt
​string

Optional field that indicates the general opening hour of the location.

Example: 08:00 AM
closesAt
​string

Optional field that indicates the general closing hour of the location.

Example: 05:00 PM
lunchStart
​string

Optional field that indicates the lunch start at the location.

Example: 12:00 PM
lunchEnd
​string

Optional field that indicates the lunch end at the location.

Example: 01:00 PM

Query information on a location based on an ID.

GET
https://scheduling.services.{domain}
/locations/{id}

Query for information on a location by ID. This can either be the full set of data for that location, or filtered down to specific keys through the _elements query parameter.

Query information on a location based on an ID. › path Parameters

id
​string · required

ID property of a Location object.

Example: 13733

Query information on a location based on an ID. › query Parameters

_elements
​string

Comma-delimited list of location object keys to return in the response JSON.

Example: id,type

Query information on a location based on an ID. › Responses

Success retrieving the requested location.

id
​integer
name
​string
​LocationAddress
​object[]
opensAt
​string

Optional field that indicates the general opening hour of the location.

Example: 08:00 AM
closesAt
​string

Optional field that indicates the general closing hour of the location.

Example: 05:00 PM
lunchStart
​string

Optional field that indicates the lunch start at the location.

Example: 12:00 PM
lunchEnd
​string

Optional field that indicates the lunch end at the location.

Example: 01:00 PM

Search for locations

GET
https://scheduling.services.{domain}
/locations/search

Based on the given radius and serviceId, return all locations that meet the criteria. The search criteria can be an address that this endpoint will attempt to geocode, or a predetermined set of geographic coordinates.

Search for locations › query Parameters

serviceId
​integer · required

The Labcorp service identifier.

radius
​integer · min: 1

A radius, in miles, from the starting address to use when searching for a location.

address
​string

The starting address to use for the location search. The endpoint will attempt to parse and geocode the provided value. A full street address is preferred and will geocode to the coordinates of that address; this falls back to geocoding the zip code if provided, i.e. the center of the zip code.

Example: 123 Main St Raleigh NC 27615
city
​string

City to use for the location search.

Example: Raleigh
state
​string

State to use for the location search.

Example: NC
latitude
​number · float

Latitude of the starting search point. Must be paired with longitude and is only used if address is not provided.

longitude
​number · float

Longitude of the starting search point. Must be paired with latitude and is only used if address is not provided.

weekday
​string · enum

Optional day(s) of the week to require location support. Multiple instances of this query parameter can be sent to filter on several days, e.g. weekday=SATURDAY&weekday=SUNDAY to search for locations open during the weekend.

Enum values:
MONDAY
TUESDAY
WEDNESDAY
THURSDAY
FRIDAY
SATURDAY
SUNDAY
timeframe
​string · enum

Optional time(s) of day against which locations must be open. Multiple instances of this query parameter can be sent to filter on more than one value, e.g. timeframe=MIDDAY&timeframe=EVENING if mornings will not work.

  • MORNING - prior to 10AM
  • MIDDAY - between 10AM and 2PM
  • EVENING - after 2PM
Enum values:
MORNING
MIDDAY
EVENING

Search for locations › Responses

Success retrieving location results, sorted by ascending distance from the starting search point.

Zero or more locations that matched the provided search criteria, sorted by distance.

id
​integer
name
​string
​LocationAddress
​object[]
opensAt
​string

Optional field that indicates the general opening hour of the location.

Example: 08:00 AM
closesAt
​string

Optional field that indicates the general closing hour of the location.

Example: 05:00 PM
lunchStart
​string

Optional field that indicates the lunch start at the location.

Example: 12:00 PM
lunchEnd
​string

Optional field that indicates the lunch end at the location.

Example: 01:00 PM
distanceFromStartingPoint
​number · float

Distance in miles from the starting search point.

Example: 1.2