TRtryvital
order

Get Area Info

Changed on

GET information about an area with respect to lab-testing.

Information returned:

  • Whether a given zip code is served by our Phlebotomy network.
  • List of Lab locations in the area.
get/v3/order/area/info

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v3/order/area/info
  • Auth
    API key in header x-vital-api-key

Query parameters

zip_codestring required

Zip code of the area to check

radius'10' | '20' | '25' | '50' | '100'

ℹ️ This enum is non-exhaustive.

Radius in which to search in miles

lab'quest' | 'labcorp' | 'bioreference' | 'sonora_quest'

ℹ️ This enum is non-exhaustive.

Lab to check for PSCs

labsClientFacingLabs[] nullable

List of labs to check for PSCs

lab_account_idstring uuid nullable

Lab Account ID to use for availability checks

Response

Successful Response

zip_codestring required
central_labsobject required

Changes

  • 754fbcad6919Revision changes
    • warning

      added the new upfront_payment enum value to the /// response property for the response status

  • 39afc7980803Revision changes
    • warning

      changed the pattern of the query request parameter zip_code from ^\d{5}$ to ^\d{5}(?:-?\d{4})?$