Retrieve Clinic by slug

1 min

GET

https://developer.digitail.io/api/v1/public/clinics/{slug}

Permissions needed: NONE Returns Clinic details.

Path Parameters

slugstringrequired
Description
The Clinic slug

Query Parameters

includestring
Description
Additional info to include. You can use multiple, comma separated. Options: country, country.language, schedules, schedules.intervals, visit_types.

Responses

200Successful operation

object
- dataobject
  - idinteger
    Example
    1
  - namestring
    Example
    Animal Hospital of All Pets
  - addressstring
    Example
    Yigal Alon St 126, Tel Aviv-Yafo, 6744332, Israel
  - phonestring
    Example
    555-555 5555
  - emailstring
    Example
    [email protected]
  - citystring
  - streetstring
    Example
    Yigal Alon Street
  - street_numberstring
    Example
    126
  - regionstring
    Example
    Tel Aviv District
  - timezonestring
    Example
    Asia/Jerusalem
  - zipstring
    Example
    6744332
  - countryobject
    - idinteger
      Example
      6
    - namestring
      Example
      United States
    - iso_codestring
      Example
      us
    - codestring
      Example
      usa
    - languageobject
      - idinteger
        Example
        6
      - namestring
        Example
        English (US)
      - short_namestring
        Example
        en-us
      - codestring
        Example
        en-us
  - preferencesobject
    Description
    The subset of clinic settings exposed on public and pet-parent payloads. The numeric toggles are 0 or 1.
    - currencystring
      Example
      CAD
    - localestring
      Example
      en
    - shop_enablednumber
    - chat_app_integrationnumber
      Example
      1
    - require_client_addressnumber
    - clinic_share_case_filenumber
    - any_staff_option_disablednumber
    - auto_approve_online_appointmentsnumber
    - appointment_reason_requirednumber
      Example
      1
    - first_availability_not_beforenumber
      Example
      30
      Description
      Minutes from now before the first bookable slot.
    - selling_price_includes_taxboolean
  - visit_typesitems[]
  - visit_type_categoriesobject[]
    - categorystring
    - labelstring
    - visit_typesitems[]
  - public_noticestring
  - logostring

curl

curl --request GET \
     --url https://developer.digitail.io/api/v1/public/clinics/{slug} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/public/clinics/{slug}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/public/clinics/{slug}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/public/clinics/{slug}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "data": {
    "id": 1,
    "name": "Animal Hospital of All Pets",
    "address": "Yigal Alon St 126, Tel Aviv-Yafo, 6744332, Israel",
    "phone": "555-555 5555",
    "email": "[email protected]",
    "city": "",
    "street": "Yigal Alon Street",
    "street_number": 126,
    "region": "Tel Aviv District",
    "timezone": "Asia/Jerusalem",
    "zip": 6744332,
    "country": {
      "id": 6,
      "name": "United States",
      "iso_code": "us",
      "code": "usa",
      "language": {
        "id": 6,
        "name": "English (US)",
        "short_name": "en-us",
        "code": "en-us"
      }
    },
    "preferences": {
      "currency": "CAD",
      "locale": "en",
      "shop_enabled": 0,
      "chat_app_integration": 1,
      "require_client_address": 0,
      "clinic_share_case_file": 0,
      "any_staff_option_disabled": 0,
      "auto_approve_online_appointments": 0,
      "appointment_reason_required": 1,
      "first_availability_not_before": 30,
      "selling_price_includes_tax": false
    },
    "visit_types": [
      ""
    ],
    "visit_type_categories": [
      {
        "category": "",
        "label": "",
        "visit_types": [
          ""
        ]
      }
    ],
    "public_notice": "",
    "logo": ""
  }
}