ARE YOU USING SOMEONE ELSE'S SOFTWARE?
We'll give you 1-FREE month to switch to Bizstim!
Bizstim Business Software BOOK DEMO
TERMS & CONDITIONS:
  • at least 1 month with the other company
  • provide a screenshot of your billing history
  • purchase a paid subscription with us
  • when verified we'll add 1-FREE month to your account
  • you can stack our 3 months at 50%-OFF offer
  • not available to returning accounts

API Documentation

  1. Home
  2. API Docs
  3. API Index
  4. Locations
Locations › GET Methods
TABLE OF CONTENTS GET: All Locations GET: Location

GET: ALL LOCATIONS

Type: GET
Method: locations
Parameter: (integer) {start} / {limit}
URL Example: https://www.bizstim.com/api/locations/0/20
start parameter refers to the first record to return.  Default = 0.
limit parameter refers to the number of records to return.  Default = 20.  Maximum = 100.
start and limit can be omitted from the URL and their defaults will be chosen.
total key in the json object is the total number of records found.  Use this to create your own pagination.
ELEMENT TYPE DESCRIPTION
id integer Unique id.
location_status integer 0=inactive, 1=active, 2=deleted
location_name string name of the location
location_address string street number, street name and suite number
location_zipcode string zipcode or postal code for the location
location_city string what is the city of the location?
location_state string what is the state or province of the location?
location_country string what is the country of the location?
location_p_phone string primary phone number for the location
location_s_phone string secondary phone number for the location
location_email string e-mail for the location
online_booking integer is this location displayed for online booking? (0=no, 1=yes)
practs array what practitioners are associated with this location when using the online booking tool? (online_booking must have a value of 1 if there is an array present) 
{
    "status": "success",
    "total": 18,
    "response": [
        {
            "id": "19",
            "location_status": "2",
            "location_name": "TestLocation",
            "location_address": "",
            "location_zipcode": "",
            "location_city": "",
            "location_state": "",
            "location_country": "",
            "location_p_phone": "",
            "location_s_phone": "",
            "location_email": "",
            "online_booking": "0",
            "practs": ""
        },
        {
            ...
        }
    ]
}

GET: LOCATION

Type: GET
Method: location
Parameter: (integer) {location_id}
URL Example: https://www.bizstim.com/api/location/24
ELEMENT TYPE DESCRIPTION
id integer Unique id.
location_status integer 0=inactive, 1=active, 2=deleted
location_name string name of the location
location_address string street number, street name and suite number
location_zipcode string zipcode or postal code for the location
location_city string what is the city of the location?
location_state string what is the state or province of the location?
location_country string what is the country of the location?
location_p_phone string primary phone number for the location
location_s_phone string secondary phone number for the location
location_email string e-mail for the location
online_booking integer is this location displayed for online booking? (0=no, 1=yes)
practs array what practitioners are associated with this location when using the online booking tool? (online_booking must have a value of 1 if there is an array present) 
{
    "status": "success",
    "response": {
        "id": "24",
        "location_status": "1",
        "location_name": "Central Library CDB",
        "location_address": "123 Main St. East",
        "location_zipcode": "L7H 2H7",
        "location_city": "Hamilton",
        "location_state": "ONTARIO",
        "location_country": "Canada",
        "location_p_phone": "(905) 388-1541",
        "location_s_phone": "(905) 388-1541",
        "location_email": "mymail@mail.com",
        "online_booking": "1",
        "practs": "351,354,355,356,358"
    }
}