---
title: Get Clinic details by ID
slug: import-test-pdf/get-clinic-details-by-id
createdAt: 2025-10-28T16:28:34.257Z
---
{
"id": "WUsIZ1DTOj-G_T_cP0vHO",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/api/v1/clinic/{id}",
"servers": [],
"name": "Get Clinic details by ID",
"description": "Returns a Clinic entity",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [
{
"kind": "optional",
"name": "include",
"type": "string",
"description": "Additional info to include. You can use multiple, comma separated. Options: country,owner, reminderPeriods, services
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful operation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Clinic",
"customType": "Clinic",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Animal Hospital of All Pets"
},
{
"name": "address",
"kind": "optional",
"type": "string",
"description": "",
"example": "Yigal Alon St 126, Tel Aviv-Yafo, 6744332, Israel"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": "",
"example": "555-555 5555"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": "",
"example": "clinic@example.com"
},
{
"name": "street",
"kind": "optional",
"type": "string",
"description": "",
"example": "Yigal Alon Street"
},
{
"name": "street_number",
"kind": "optional",
"type": "string",
"description": "",
"example": 126
},
{
"name": "region",
"kind": "optional",
"type": "string",
"description": "",
"example": "Tel Aviv District"
},
{
"name": "timezone",
"kind": "optional",
"type": "string",
"description": "",
"example": "Asia/Jerusalem"
},
{
"name": "zip",
"kind": "optional",
"type": "string",
"description": "",
"example": 6744332
},
{
"name": "country",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Country",
"customType": "Country",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 6
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "United States"
},
{
"name": "iso_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "us"
},
{
"name": "code",
"kind": "optional",
"type": "string",
"description": "",
"example": "usa"
}
]
},
{
"name": "owner",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Vet",
"customType": "Vet",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "first_name",
"kind": "optional",
"type": "integer",
"description": "",
"example": "John"
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Doe"
},
{
"name": "full_name",
"kind": "optional",
"type": "string",
"description": "",
"example": "John Doe"
},
{
"name": "name_with_title",
"kind": "optional",
"type": "string",
"description": "",
"example": "Dr. John Doe"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": "",
"example": "vet@example.com"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": "",
"example": "123456789"
},
{
"name": "avatar",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://vet.digitail.io/images/profilepic.jpg"
},
{
"name": "stamp",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://vet.digitail.io/images/signature.jpg"
},
{
"name": "license_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "123456789"
},
{
"name": "job_title",
"kind": "optional",
"type": "string",
"description": "",
"example": "Dr."
},
{
"name": "deleted_at",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "active",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
},
{
"name": "video_link",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://digitail.com/video"
},
{
"name": "public_appointment_link",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://digitail.com/clinics/clinic-slug/vet-slug"
},
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "two_factor_enabled",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
},
{
"name": "has_chat_user",
"kind": "optional",
"type": "boolean",
"description": "true if chatUser is active, false if non-existent or inactive",
"example": true
}
]
},
{
"name": "hasGroup",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "rooms",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Room",
"customType": "Room[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Consultation Room 1"
}
]
},
{
"name": "services",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Service",
"customType": "Service[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "category_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "label",
"kind": "optional",
"type": "string",
"description": "",
"example": "General Checkup"
},
{
"name": "translation_slug",
"kind": "optional",
"type": "string",
"description": "",
"example": "services.checkups.general_checkup"
}
]
},
{
"name": "reminders",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "period",
"kind": "optional",
"type": "integer",
"description": "Reminder will be sent X days/weeks/months (period_type) before the appointment",
"example": 2
},
{
"name": "period_type",
"kind": "optional",
"type": "integer",
"description": "* `0` - Day, * `1` - Week, * `2` - Month,\n",
"example": 2
},
{
"name": "notification_type",
"kind": "optional",
"type": "integer",
"description": "* `0` - Upcoming Reminder, * `1` - Recommended Reminder, * `2` - Product Reminder,\n",
"example": 1
}
]
},
{
"name": "meetings_link",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://meetings.example.com"
},
{
"name": "token",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "cash_register_notes",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url /api/v1/clinic/{id} \\\n --header 'accept: application/json'"
},
{
"id": "example-1-javascript",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/api/v1/clinic/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "example-2-ruby",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/v1/clinic/{id}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
},
{
"id": "example-3-python",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"/api/v1/clinic/{id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "example-0-curl"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Successful operation\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"Animal Hospital of All Pets\",\n \"address\": \"Yigal Alon St 126, Tel Aviv-Yafo, 6744332, Israel\",\n \"phone\": \"555-555 5555\",\n \"email\": \"clinic@example.com\",\n \"street\": \"Yigal Alon Street\",\n \"street_number\": 126,\n \"region\": \"Tel Aviv District\",\n \"timezone\": \"Asia/Jerusalem\",\n \"zip\": 6744332,\n \"country\": {\n \"id\": 6,\n \"name\": \"United States\",\n \"iso_code\": \"us\",\n \"code\": \"usa\"\n },\n \"owner\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"full_name\": \"John Doe\",\n \"name_with_title\": \"Dr. John Doe\",\n \"email\": \"vet@example.com\",\n \"phone\": \"123456789\",\n \"avatar\": \"https://vet.digitail.io/images/profilepic.jpg\",\n \"stamp\": \"https://vet.digitail.io/images/signature.jpg\",\n \"license_number\": \"123456789\",\n \"job_title\": \"Dr.\",\n \"deleted_at\": \"\",\n \"active\": true,\n \"video_link\": \"https://digitail.com/video\",\n \"public_appointment_link\": \"https://digitail.com/clinics/clinic-slug/vet-slug\",\n \"type\": \"\",\n \"two_factor_enabled\": true,\n \"has_chat_user\": true\n },\n \"hasGroup\": false,\n \"rooms\": [\n {\n \"id\": 1,\n \"clinic_id\": 1,\n \"name\": \"Consultation Room 1\"\n }\n ],\n \"services\": [\n {\n \"id\": 1,\n \"category_id\": 1,\n \"label\": \"General Checkup\",\n \"translation_slug\": \"services.checkups.general_checkup\"\n }\n ],\n \"reminders\": [\n {\n \"id\": 1,\n \"period\": 2,\n \"period_type\": 2,\n \"notification_type\": 1\n }\n ],\n \"meetings_link\": \"https://meetings.example.com\",\n \"token\": \"\",\n \"cash_register_notes\": \"\"\n }\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": ""
}
]
}