Business details

Business details can be queried using this API. slashQ API platform is expecting an api_key in the API request, which you can get from the business settings page. On a successful API query, you will get business details such as business name, address, the date format, and the SMS subscription information. Also, this API provides information regarding the Booking Widget button attributes like button dimensions, color, text, and font size.


{warning} All requests are passed to the host URL. You can append corresponding API endpoints to the host URL depending on your requirement.

Method URI Description
GET /api/business Get business details

URL Params


Data Params


{info} The API_KEY is the token that the server needs in order to auth the request.

{success} Success Response

Code 200


  "status": "success",
  "message": "Business details fetched successfully",
  "data": {
    "name": "ABC Group",
    "address": "8026 N. Heather St.Baltimore, MD 21206",
    "date_format": "m-d-Y",
    "sms_enabled": true,
    "locations": [
        "id": 2,
        "name": "Blue bird building"
        "id": 3,
        "name": "Orange sky building"
    "widget_settings": {
      "width": 400,
      "height": 60,
      "text": "Book an Appointment",
      "font_size": 20,
      "font_color": '#2e2e2e',
      "bg_color": '#ffe072'

{warning} Unauthorized request

Code 401


  "status": "failure",
  "message": "Unauthorized request"

{danger} Not found

Code 404


  "status": "failure",
  "message": "Not found"