Retrieve a Clinic

1 min

GET

https://developer.digitail.io/api/v1/clinic/{id}

Permissions needed: NONE ENDPOINT: api/v1/clinic/{id} to be deprecated in favor of api/v1/clinics/{id} Get all details associated with a specific clinic.

Query Parameters

includestring
Description
Additional info to include. You can use multiple, comma separated. Options: country,owner, reminderPeriods

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]
  - streetstring
    Example
    Yigal Alon Street
  - street_numberstring
    Example
    126
  - regionstring
    Example
    Tel Aviv District
  - timezonestring
    Example
    Asia/Jerusalem
  - zipstring
    Example
    6744332
  - countrycountry
  - ownerdata
  - vetsdata[]
  - hasGroupinteger
  - group_idinteger
  - roomsroom[]
  - remindersitems[]
  - visit_type_remindersobject[]
    Description
    Returned with include=reminderPeriods. Upcoming appointment reminders of each visit type that has its own version of the template; any other visit type uses reminders.
    - visit_type_idinteger
      Example
      12
    - remindersitems[]
  - meetings_linkstring
    Example
    https://meetings.example.com
  - tokenstring
  - cash_register_notesstring
  - sms_enabledboolean
  - appointment_smsinteger
  - appointment_emailinteger
  - reminder_appointment_smsinteger
  - reminder_appointment_emailinteger
  - reminder_health_plan_smsinteger
  - reminder_health_plan_emailinteger
  - first_availability_not_beforeinteger
  - has_intakeinteger
  - websitestring
  - gtm_idstring
  - public_noticestring
  - latitudenumber<float>
    Format
    float
  - longitudenumber<float>
    Format
    float
  - logostring
  - slugstring

curl

curl --request GET \
     --url https://developer.digitail.io/api/v1/clinic/{id} \
     --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/clinic/{id}", 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/clinic/{id}")

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/clinic/{id}"

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]",
    "street": "Yigal Alon Street",
    "street_number": 126,
    "region": "Tel Aviv District",
    "timezone": "Asia/Jerusalem",
    "zip": 6744332,
    "country": {},
    "owner": {},
    "vets": [
      ""
    ],
    "hasGroup": 0,
    "group_id": 0,
    "rooms": [
      ""
    ],
    "reminders": [
      ""
    ],
    "visit_type_reminders": [
      {
        "visit_type_id": 12,
        "reminders": [
          ""
        ]
      }
    ],
    "meetings_link": "https://meetings.example.com",
    "token": "",
    "cash_register_notes": "",
    "sms_enabled": false,
    "appointment_sms": 0,
    "appointment_email": 0,
    "reminder_appointment_sms": 0,
    "reminder_appointment_email": 0,
    "reminder_health_plan_sms": 0,
    "reminder_health_plan_email": 0,
    "first_availability_not_before": 0,
    "has_intake": 0,
    "website": "",
    "gtm_id": "",
    "public_notice": "",
    "latitude": "",
    "longitude": "",
    "logo": "",
    "slug": ""
  }
}