API-V2 Documentation

Introduction

Welcome to the InQuicker API V2 Docs! 👋

The second version (V2) of our API provides read-access to certain kinds of data.

This data can include:

Schedules
Facilities
Providers
Locations
Regions
Service lines
Appointment types

If your health system is set up in InQuicker, this API provides a way to access that data so that you can build a totally customized online booking experience on your own website. Our partners often use the API to build out schedule inventory pages, directory pages for providers, and other resources in this vein.

Topics

Authentication

All API requests must be sent over HTTPS and the API Key must be included in the request as a parameter:

https://api.inquicker.com/v2/schedules?api_key=db19faf29227a76ad88e22af411a8b3a16356dc

Response Structure

Every response is contained within an envelope. This is a predictable set of keys with which you can expect to interact with:

{
      'data': [],
      'metadata': {
        'statusCode': 200,
        'pagination': {
          'totalItems': 100,
          'totalPages': 10,
          'currentPage': '/schedules?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3',
          'previousPage': '/schedules?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3',
          'nextPage': '/schedules?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3'
        },
        'error': null,
        'poweredBy': {
          'text': 'Powered by InQuicker',
          'url': 'https://example.inquicker.com'
        }
      }
    }

Data

The data key is the actual results that were requested from the end-point.

Metadata

The metadata key is used to give extra information about the response to the developer, such as pagination, errors, and status code information related to the request.

Error Handling

When an error occurs the API will return a ['metadata']['statusCode'] which contains the HTTP status code, as well as an error description that will be in the ['metadata']['error'] key.

Status	Description
200	The request was successful and results were returned
401	The API key provided is invalid
404	The resource or end-point request does not exist
500	Internal server error has occured

JSONP

JSONP is an effective cross-domain communication technique, one that lets you bypass the same-origin policy limitations imposed by the current browsers.

In order to use JSONP with the API you will need to request a JSONP API key from InQuicker. The JSONP API key has some technical differences which include:

The API key can be safely exposed to clients as it is restricted to be read-only.
All responses are returned with the 200 OK HTTP status code regardless of the outcome. The real response code is contained in the ['metadata']['statusCode'] response key. This allows for proper handling of response codes in your JSONP client application.

In order to have your callback executed, all that needs to be done is to have a callback parameter with the function name specified in the request:

Request

https://api.inquicker.com/v2/schedules?callback=callbackFunction&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3

Response

callbackFunction({
      'data': [],
      'metadata': {
        'statusCode': 200,
        'pagination': {
          'totalItems': 100,
          'totalPages': 10,
          'currentPage': '/schedules?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3',
          'previousPage': '/schedules?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3',
          'nextPage': '/schedules?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc3'
        },
        'error': null,
        'poweredBy': {
          'text': 'Powered by InQuicker',
          'url': 'https://example.inquicker.com'
        }
      }
    });

Pagination

Responses with multiple results will be paginated to 50 items by default. You can set a custom per-page amount with the per_page parameter, and request specific page results by passing the page parameter.

To retrieve additional pages after the intitial request, the pagination URL paths within the responses metadata key can be used:

Parameter	Description
totalItems	The total number of results found
totalPages	The total number of pages of results found
currentPage	The current page requested
previousPage	The previous page of results
nextPage	The next page of results

Powered by Branding

InQuicker’s branding standards require a “Powered by InQuicker” link to be included on all pages using InQuicker’s scheduling tools. To ensure search optimization still occurs for customer’s branded subdomain, we also include a link and anchor text within the metadata of each API response. You should link the powered by InQuicker logo to response['metadata']['poweredByURL'] response using the response['metadata']['poweredByText'] as the anchor text on any page where you use the API.

The powered by logo can be downloaded at: https://iqapp.inquicker.com/assets/site/logos/powered-by.png

Send To Registration Page

In order to send patients to the registration page, the URL will need to be generated from the response that you receive from the schedules end-point.

Base URL

The base registration URL for the schedule is located in the ['data']['registrationUrl'] of the response and will look like the following:

https://example.inquicker.com/schedule/5

Parameters

Two parameters from the response will also be needed in order to complete the registration URL:

Response key	URL Parameter	Description
time	at	The registration time for the visit
appointmentTypes	appointment_type	The appointment type for the visit. If the appointmentTypes response is null, the appointment_type parameter should not be passed to the registration URL.

The required parameters will be available within the availableTimes key of the schedules response.

"availableTimes": [{
       "date": "2014-09-17",
       "times": [{
         "time": "2014-09-17T09:00:00-04:00",
         "appointmentTypes": [{
           "id": "heart-surgery",
           "name": "Heart Surgery"
         }, {
           "id": "general-consultation",
           "name": "General Consultation"
         }, {
           "id": "brain-surgery",
           "name": "Brain Surgery"
         }]
      }]
    }]

Completed Example URL

https://example.inquicker.com/schedule/5?appointment_type=heart-surgery&at=2014-11-05T14:00:00Z

Resources

Schedules

Description of what schedules are goes here.

List Schedules

GET

/schedules{?api_key,facilities,providers,regions,locations,schedule_context,services,service_lines,appointment_types,start_date,end_date,languages,query,radius,remote_appointment_type_id,remote_location_id,remote_provider_id,longitude,latitude,include,inactive,page,per_page,callback}

Lists the schedules available to the health system.

Parameters
api_key
string (required)
The key required to authenticate with the API.

facilities
string (optional) Example: westcoast-clinic,general-hospital
The comma separated names of facilities to filter by.

providers
string (optional) Example: dr-john-smith,dr-sam-adams
The comma separated names of providers to filter by.

regions
string (optional) Example: north
The comma separated names of regions to filter by.

locations
string (optional) Example: nanaimo
The comma separated names of locations to filter by.

schedule_context
string (optional) Example: patient
The schedule contexts to filter by, default value is ‘patient’, options are ‘patient’, ‘internal’, and ‘discharge’.

services
string (optional) Example: family-medicine
The comma separated names of services to filter by.

service_lines
string (optional) Example: trauma-care
The comma separated names of service lines to filter by.

appointment_types
string (optional) Example: heart-surgery
The comma separated names of appointment types to filter by.

start_date
string (optional) Example: 2016-01-30
The start of availability to filter by.

end_date
string (optional) Example: 2016-02-25
The end of availability to filter, no more then 31 days past the start_date.

include
string (optional) Default: None Example: facility,provider
The comma separated names of response payloads to include.

languages
string (optional) Example: english,spanish
The comma separated list of languages spoken to filter by.

latitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

longitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

radius
integer (optional) Default: 25
Limit results to schedules within this many miles of the specified latitude/longitude.

remote_appointment_type_id
string (optional) Example: 12345
Remote Appointment Type ID to filter by, if used the appointment_types option will be ignored.

remote_location_id
string (optional) Example: 12345
Remote Location ID to filter by, if used the locations option will be ignored.

remote_provider_id
string (optional) Example: 12345
Remote Provider ID to filter by, if used the providers option will be ignored.

query
string (optional)
Searches facility and provider names for the string passed.

inactive
boolean (optional) Default: false
Includes schedules that are not yet active in the system.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displaySchedules
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
      'hasAvailability': true,
      'appointmentTypes': [
        { "id": "heart-surgery", "name": "Heart Surgery", "remote_id": null },
        { "id": "brain-surgery", "name": "Brain Surgery", "remote_id": "123456" },
        { "id": "general-consultation", "name": "General Consultation", "remote_id": null }
      ],
      'nextAvailableTimes': [
        { "appointmentType": "heart-surgery", "time": "2014-09-17T15:30:00-04:00" },
        { "appointmentType": "general-consultation", "time": "2014-09-21T12:30:00-04:00" },
        { "appointmentType": "brain-surgery", "time": "2014-09-27T10:30:00-04:00" }
      ],
      'registrationUrl': 'https://example.inquicker.com/schedule/new/schedule-name',
      'service': {
        'id': 'emergency-room',
        'name': 'Emergency Room'
      },
      'facility': {
        'id': 'example-medical-clinic',
        'name': 'example Medical Clinic',
        'homepageUrl': 'http://examplemedicalclinic.com',
        'inventoryUrl': 'https://inquicker.com/facility/example-medical-clinic',
        'logoImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png'
       },
      'provider': {
        'id': 'john-smith',
        'name': 'John Smith',
        'suffix': 'MD',
        'gender': 'Male',
        'phone': '2502442832',
        'credentials': ['American Board of Sport Psychology'],
        'languages': [{
          'id': 'english',
          'name': 'English'
        }],
        'services': [{
          'id': 'pediatrics',
          'name': 'Pediatrics'
        }, {
          'id': 'internal-medicine',
          'name': 'Internal Medicine'
        }],
        'gradSchool': 'Loma Linda University School of Medicine',
        'undergradSchool': 'UBC Faculty of Medicine',
        'inventoryUrl': 'https://inquicker.com/provider/john-smith',
        'profileImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png'
      },
      'location': {
        'id': 'nanaimo',
        'name': 'Nanaimo',
        'address': '1200 Dufferin Crescent',
        'state': 'TN',
        'city': 'Nashville',
        'zip': 90210,
        'phone': '2532402833',
        'latitude': 35.7671,
        'longitude': -86.9199,
        'services': [{
          'id': 'pediatrics',
          'name': 'Pediatrics'
         }, {
          'id': 'internal-medicine',
          'name': 'Internal Medicine'
        }]
      },
      'region': {
        'id': 'north',
        'name': 'North'
      },
      "id": "387d55ef-2ba9-4368-9c7e-ef4e95351352",
      "availableTimes": [{
        "date": "2014-09-17",
        "times": [{
          "time": "2014-09-17T09:00:00-04:00",
          "appointmentTypes": [{
            "id": "heart-surgery",
            "name": "Heart Surgery"
          }, {
            "id": "general-consultation",
            "name": "General Consultation"
          }, {
            "id": "brain-surgery",
            "name": "Brain Surgery"
          }] }, {
          "time": "2014-09-17T09:15:00-04:00",
          "appointmentTypes": [{
            "id": "heart-surgery",
            "name": "Heart Surgery"
          }, {
            "id": "general-consultation",
            "name": "General Consultation"
          }, {
            "id": "brain-surgery",
            "name": "Brain Surgery"
          }] }
   }
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalResults': 100,
      'totalPages': 10,
      'currentPage': '/schedules?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage': '/schedules?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage': '/schedules?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 422Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 422,
    'pagination': null,
    'error': 'Filter date must not exceed 31 days and be in ISO8601 format.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
The facility is a representation of a Hospital, Clinic, Practice, etc - an organizational entity that  can have one or more access points, and from access points, schedules. A facility can have multiple addresses, and can optionally be associated with a region.

List Facilities

GET

/facilities{?api_key,page,per_page,regions,languages,latitude,longitude,radius,query,callback}

Returns a list of facilities.

Parameters
api_key
string (required)
The key required to authenticate with the API.

regions
string (optional) Example: north
The comma separated names of regions to filter by.

languages
string (optional) Example: english,spanish
The comma separated list of languages spoken to filter by.

latitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

longitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

radius
integer (optional) Default: 25
Limit results to schedules within this many miles of the specified latitude/longitude.

query
string (optional)
Searches facility names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayFacilities
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
    'id': 'example-medical-clinic',
    'name': 'example Medical Clinic',
    'inventoryUrl': 'https://inquicker.com/facility/example-medical-clinic',
    'homepageUrl': 'http://examplemedicalclinic.com',
    'logoImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png',
    'timeZone': 'Eastern Time (US & Canada)',
    'locations' : [{
      'id': 'nanaimo',
      'name': 'Nanaimo',
      'address': '1200 Dufferin Crescent',
      'state': 'TN',
      'city': 'Nashville',
      'zip': 90210,
      'phone': '2507557691'
      'longitude': 9.96233,
      'latitude': 49.80404
    }],
    'providers' : [{
      'id': 'john-smith',
      'name': 'John Smith',
      'suffix': 'MD',
      'gender': 'Male',
      'phone': '2502402832',
      'credentials': ['American Board of Sport Psychology'],
      'languages': [{
        'id': 'english',
        'name': 'English'
      }],
      'services': [{
        'id': 'pediatrics',
        'name': 'Pediatrics'
      }, {
        'id': 'internal-medicine',
        'name': 'Internal Medicine'
      }],
      'gradSchool': 'Loma Linda University School of Medicine',
      'undergradSchool': 'UBC Faculty of Medicine',
      'inventoryUrl': 'https://inquicker.com/provider/john-smith',
      'profileImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png'
    }],
    'region': {
      'id': 'north',
      'name': 'North'
    }
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalItems': 100,
      'totalPages': 10,
      'currentPage': '/facilities?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage': '/facilities?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage': '/facilities?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}

Retrieve a Facility

GET

/facilities/{id}{?api_key,callback}

Returns a single facility.

Parameters
id
string (required) Example: example-medical-clinic
The unique identifier of the facility.

api_key
string (required)
The key required to authenticate with the API.

callback
string (optional) Example: displayFacilities
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': {
    'id': 'example-medical-clinic',
    'name': 'example Medical Clinic',
    'inventoryUrl': 'https://inquicker.com/facility/example-medical-clinic',
    'homepageUrl': 'http://examplemedicalclinic.com',
    'logoImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png?1400640688',
    'timeZone': 'Eastern Time (US & Canada)',
    'locations' : [{
      'id': 'nanaimo',
      'name': 'Nanaimo',
      'address': '1200 Dufferin Crescent',
      'state': 'TN',
      'city': 'Nashville',
      'zip': 90210,
      'phone': '2507557691',
      'longitude': 9.96233,
      'latitude': 49.80404
    }],
    'providers' : [{
      'id': 'john-smith',
      'name': 'John Smith',
      'suffix': 'MD',
      'gender': 'Male',
      'phone': '2502432832',
      'credentials': ['American Board of Sport Psychology'],
      'languages': [{
        'id': 'english',
        'name': 'English'
      }],
      'services': [{
        'id': 'pediatrics',
        'name': 'Pediatrics'
      }, {
        'id': 'internal-medicine',
        'name': 'Internal Medicine'
      }],
      'gradSchool': 'Loma Linda University School of Medicine',
      'undergradSchool': 'UBC Faculty of Medicine',
      'inventoryUrl': 'https://inquicker.com/provider/john-smith',
      'profileImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png?1400640688'
    }],
    'region': {
      'id': 'north',
      'name': 'North'
    }
  },
  'metadata': {
    'statusCode': 200,
    'pagination': null,
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 404Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 404,
    'pagination': null,
    'error': 'The requested facility (example-medical-clinic) could not be found.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
The provider is a representation of a person who is a provider of health care.

List Providers

GET

/providers{?api_key,page,per_page,facilities,inactive,integrated,languages,latitude,longitude,npi,query,radius,regions,callback}

Returns a list of providers.

Parameters
api_key
string (required)
The key required to authenticate with the API.

regions
string (optional) Example: north
The comma separated names of regions to filter by.

facilities
string (optional) Example: westcoast-clinic,general-hospital
The comma separated names of facilities to filter by.

inactive
boolean (optional) Default: false
Includes providers that do not yet have schedules active in the system.

integrated
boolean (optional) Default: nil
Limit results to providers with/without integration.

languages
string (optional) Example: english,spanish
The comma separated list of languages spoken to filter by.

latitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

longitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

npi
string (optional)
Limit reslts to providers with this NPi.

radius
integer (optional) Default: 25
Limit results to schedules within this many miles of the specified latitude/longitude.

query
string (optional)
Searches provider names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayProviders
The JSONP callback function name to be executed.

visible
boolean (optional) Default: false
Exclude providers that have hidden schedules.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
      'id': 'john-smith',
      'name': 'John Smith',
      'npi': '01234567890',
      'suffix': 'MD',
      'gender': 'Male',
      'phone': '2502442832',
      'credentials': ['American Board of Sport Psychology'],
      'languages': [{
        'id': 'english', 'English'
      }],
      'services': [{
        'id': 'pediatrics',
        'name': 'Pediatrics'
      }, {
        'id': 'internal-medicine',
        'name': 'Internal Medicine'
      }],
      'facilities': [{
        'id': 'example-medical-clinic',
        'name': 'example Medical Clinic',
        'homepageUrl': 'http://examplemedicalclinic.com',
        'inventoryUrl': 'https://inquicker.com/facility/example-medical-clinic',
        'logoImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png?1400640688',
        'timeZone': 'Eastern Time (US & Canada)',
        'locations' : [{
          'id': 'nanaimo',
          'name': 'Nanaimo',
          'address': '1200 Dufferin Crescent',
          'state': 'TN',
          'city': 'Nashville',
          'zip': 90210,
          'phone': '2507557691',
          'longitude': 9.96233,
          'latitude': 49.80404
        }],
      }],
      'gradSchool': 'Loma Linda University School of Medicine',
      'undergradSchool': 'UBC Faculty of Medicine',
      'inventoryUrl': 'https://inquicker.com/provider/john-smith',
      'profileImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png?1400640688'
    ],
    'metadata': {
      'statusCode': 200,
      'pagination': {
        'totalItems': 100,
        'totalPages': 10,
        'currentPage': '/providers?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
        'previousPage': '/providers?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
        'nextPage': '/providers?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
      },
      'error': null,
      'poweredBy': {
        'text': 'Powered by InQuicker',
        'url': 'https://example.inquicker.com'
      }
    }
  }

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}

Retrieve a Provider

GET

/{api_key}/providers/{id}{?api_key,callback}

Returns an individual provider.

Parameters
id
string (required) Example: john-smith
The unique identifier of the provider.

api_key
string (required)
The key required to authenticate with the API.

callback
string (optional) Example: displayProviders
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': {
      'id': 'john-smith',
      'name': 'John Smith',
      'npi': '01234567890',
      'suffix': 'MD',
      'gender': 'Male',
      'phone': '2542402832',
      'credentials': ['American Board of Sport Psychology'],
      'languages': [{
        'id': 'english',
        'name': 'English'
      }],
      'services': [{
        'id': 'pediatrics',
        'name': 'Pediatrics'
      }, {
        'id': 'internal-medicine',
        'name': 'Internal Medicine'
      }],
      'facilities': [{
        'id': 'example-medical-clinic',
        'name': 'example Medical Clinic',
        'homepageUrl': 'http://examplemedicalclinic.com',
        'inventoryUrl': 'https://inquicker.com/facility/example-medical-clinic',
        'logoImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png?1400640688',
        'timeZone': 'Eastern Time (US & Canada)',
        'locations' : [{
          'id': 'nanaimo',
          'name': 'Nanaimo',
          'address': '1200 Dufferin Crescent',
          'state': 'TN',
          'city': 'Nashville',
          'zip': 90210,
          'phone': '2507557691',
          'longitude': 9.96233,
          'latitude': 49.80404
        }],
      }],
      'gradSchool': 'Loma Linda University School of Medicine',
      'undergradSchool': 'UBC Faculty of Medicine',
      'inventoryUrl': 'https://inquicker.com/provider/john-smith',
      'profileImageUrl': 'https://inquicker.com/files/profile/practitioner/original_964.png?1400640688'
    },
    'metadata': {
      'statusCode': 200,
      'pagination': null,
      'error': null,
      'poweredBy': {
        'text': 'Powered by InQuicker',
        'url': 'https://example.inquicker.com'
      }
    }
  }

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 404Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 404,
    'pagination': null,
    'error': 'The requested provider (john-smith) could not be found.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
Lists the locations available to the health system.

List Locations

GET

/locations{?api_key,regions,facilities,providers,latitude,longitude,radius,query,page,per_page,callback}

Returns a list of locations.

Parameters
api_key
string (required)
The key required to authenticate with the API.

regions
string (optional) Example: north
The comma separated names of regions to filter by.

facilities
string (optional) Example: westcoast-clinic,general-hospital
The comma separated names of facilities to filter by.

providers
string (optional) Example: dr-john-smith,dr-sam-adams
The comma separated names of providers to filter by.

latitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

longitude
float (optional)
Limit results to schedules within the area of the specified latitude/longitude.

radius
integer (optional) Default: 25
Limit results to schedules within this many miles of the specified latitude/longitude.

query
string (optional)
Searches locations names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayLocations
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
    'id': 'nanaimo',
    'name': 'Nanaimo',
    'address': '1200 Dufferin Crescent',
    'state': 'TN',
    'city': 'Nashville',
    'zip': 90210,
    'phone': '2507557691',
    'longitude': 9.96233,
    'latitude': 49.80404,
    'services': [{
      'id': "emergency-room",
      'name': "Emergency Room",
      'serviceLine": {
        'id': "emergency-room",
        'name': "Emergency Room"
       }
    }]
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalItems': 100,
      'totalPages': 10,
      'currentPage' : '/locations?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage' : '/locations?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage' : '/locations?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
Lists the regions available to the health system.

List Regions

GET

/regions{?api_key,page,per_page,query,callback}

Returns a list of regions.

Parameters
api_key
string (required)
The key required to authenticate with the API.

query
string (optional)
Searches region names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayRegions
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
    'id': 'pacific-north-west',
    'name': 'Pacific Northwest'
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalItems': 100,
      'totalPages': 10,
      'currentPage' : '/regions?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage' : '/regions?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage' : '/regions?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
Lists the service lines available to the health system with services.

List Service Lines

GET

/service_lines{?api_key,page,per_page,query,callback}

Returns a list of service lines.

Parameters
api_key
string (required)
The key required to authenticate with the API.

query
string (optional)
Searches service line names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayServiceLines
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
    'id': 'emergency-room',
    'name': 'Emergency Room',
    'services': [{
      'id': 'emergency-room',
      'name': 'Emergency Room'
    }, {
      'id': 'urgent-care',
      'name': 'Urgent Care'
    }]
  }, {
    'id': 'diagnostic-imaging',
    'name': 'Diagnostic Imaging',
    'services': [{
      'id': 'mammography',
      'name': 'Mammography'
    }, {
      'id': 'diagnostic-imaging',
      'name': 'Diagnostic Imaging'
    }]
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalItems': 100,
      'totalPages': 10,
      'currentPage': '/service_lines?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage': '/service_lines?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage': '/service_lines?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
Lists the appointment types available to the health system.

List Appointment Types

GET

/appointment_types{?api_key,page,per_page,query,callback}

Returns a list of appointment types.

Parameters
api_key
string (required)
The key required to authenticate with the API.

query
string (optional)
Searches appointment type names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayAppointmentTypes
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
    'id' : 'heart-surgery',
    'name' : 'Heart Surgery'
  }, {
    'id' : 'lung-surgery',
    'name' : 'Lung Surgery'
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalItems': 100,
      'totalPages': 10,
      'currentPage' : '/appointment_types?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage' : '/appointment_types?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage' : '/appointment_types?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}
Lists the languages available to the health system.

List Languages

GET

/languages{?api_key,page,per_page,query,callback}

Returns a list of appointment types.

Parameters
api_key
string (required)
The key required to authenticate with the API.

query
string (optional)
Searches language names for the string passed.

page
integer (optional) Default: 1
The page number of results to return.

per_page
integer (optional) Default: 50
The number of results to return per page. (Maximum 200)

callback
string (optional) Example: displayAppointmentTypes
The JSONP callback function name to be executed.

Response 200Toggle

Headers

Content-Type: application/json

Body

{
  'data': [{
    'id' : 'english',
    'name' : 'English'
  }, {
    'id' : 'spanish',
    'name' : 'Spanish'
  }],
  'metadata': {
    'statusCode': 200,
    'pagination': {
      'totalItems': 100,
      'totalPages': 10,
      'currentPage' : '/languages?page=3&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'previousPage' : '/languages?page=2&api_key=db19faf29227a76ad88e22af411a8b3a16356dc',
      'nextPage' : '/languages?page=4&api_key=db19faf29227a76ad88e22af411a8b3a16356dc'
    },
    'error': null,
    'poweredBy': {
      'text': 'Powered by InQuicker',
      'url': 'https://example.inquicker.com'
    }
  }
}

Response 401Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 401,
    'pagination': null,
    'error': 'The request cannot be authenticated with the API key provided.'
  }
}

Response 500Toggle

Headers

Content-Type: application/json

Body

{
  'data': null,
  'metadata': {
    'statusCode': 500,
    'pagination': null,
    'error': 'An error has occured. Our development team has been notified.'
  }
}

Introduction

Topics

Authentication ¶

Response Structure ¶

Data ¶

Metadata ¶

Error Handling ¶

JSONP ¶

Request ¶

Response ¶

Pagination ¶

Powered by Branding ¶

Send To Registration Page ¶

Base URL ¶

Parameters ¶

Completed Example URL ¶

Resources

Schedules ¶

List Schedules

Headers

Body

Headers

Body

Headers

Body

Headers

Body

List Facilities

Headers

Body

Headers

Body

Headers

Body

Retrieve a Facility

Headers

Body

Headers

Body

Headers

Body

Headers

Body

List Providers

Headers

Body

Headers

Body

Headers

Body

Retrieve a Provider

Headers

Body

Headers

Body

Headers

Body

Headers

Body

List Locations

Headers

Body

Headers

Body

Headers

Body

List Regions

Headers

Body

Headers

Body

Headers

Body

List Service Lines

Headers

Body

Headers

Body

Headers

Body

Authentication

Response Structure

Data

Metadata

Error Handling

JSONP

Request

Response

Pagination

Powered by Branding

Send To Registration Page

Base URL

Parameters

Completed Example URL

Schedules