--- title: Retrieve a Clinic slug: retrieve-a-clinic docTags: createdAt: 2026-04-21T15:22:49.957Z --- { "id": "gUo5GhCDtEJg5k08d2ztO", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://developer.digitail.io/api/v1/clinic/{id}", "servers": [ { "url": "https://developer.digitail.io/api/v1/clinic/{id}", "description": "Sandbox server (uses test data)" }, { "url": "https://vet.digitail.io/api/v1/clinic/{id}", "description": "Production server (uses live data)" } ], "name": "Retrieve a Clinic", "description": "

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

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "include", "type": "string", "description": "

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

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "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", "nullable": true, "description": "", "example": "Yigal Alon St 126, Tel Aviv-Yafo, 6744332, Israel" }, { "name": "phone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "555-555 5555" }, { "name": "email", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "clinic@example.com" }, { "name": "street", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Yigal Alon Street" }, { "name": "street_number", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": 126 }, { "name": "region", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Tel Aviv District" }, { "name": "timezone", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Asia/Jerusalem" }, { "name": "zip", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": 6744332 }, { "name": "country", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/paths/~1api~1v1~1public~1clinics~1%7Bslug%7D/get/responses/200/content/application~1json/schema/properties/data/properties/country", "customType": "country", "schema": [] }, { "name": "owner", "kind": "optional", "type": "object", "nullable": true, "description": "", "modelRef": "#/paths/~1api~1v1~1vets~1%7Bid%7D/get/responses/200/content/application~1json/schema/properties/data", "customType": "data", "schema": [] }, { "name": "vets", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1vets~1%7Bid%7D/get/responses/200/content/application~1json/schema/properties/data", "customType": "data[]", "schema": [] }, { "name": "hasGroup", "kind": "optional", "type": "integer", "description": "", "example": 0 }, { "name": "group_id", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": "" }, { "name": "rooms", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1tasks/get/responses/200/content/application~1json/schema/properties/data/items/properties/room", "customType": "room[]", "schema": [] }, { "name": "reminders", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1appointments/post/requestBody/content/application~1json/schema/properties/reminder_notifications/items", "customType": "items[]", "schema": [] }, { "name": "meetings_link", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "https://meetings.example.com" }, { "name": "token", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "cash_register_notes", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "sms_enabled", "kind": "optional", "type": "boolean", "description": "" }, { "name": "appointment_sms", "kind": "optional", "type": "integer", "description": "" }, { "name": "appointment_email", "kind": "optional", "type": "integer", "description": "" }, { "name": "reminder_appointment_sms", "kind": "optional", "type": "integer", "description": "" }, { "name": "reminder_appointment_email", "kind": "optional", "type": "integer", "description": "" }, { "name": "reminder_health_plan_sms", "kind": "optional", "type": "integer", "description": "" }, { "name": "reminder_health_plan_email", "kind": "optional", "type": "integer", "description": "" }, { "name": "first_availability_not_before", "kind": "optional", "type": "integer", "description": "" }, { "name": "has_intake", "kind": "optional", "type": "integer", "description": "" }, { "name": "website", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "gtm_id", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "public_notice", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "latitude", "kind": "optional", "type": "number", "nullable": true, "description": "", "format": "float" }, { "name": "longitude", "kind": "optional", "type": "number", "nullable": true, "description": "", "format": "float" }, { "name": "logo", "kind": "optional", "type": "string", "nullable": true, "description": "" }, { "name": "slug", "kind": "optional", "type": "string", "nullable": true, "description": "" } ] } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "h_cxvekkih9e_D-gIw93d", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/clinic/{id} \\\n --header 'accept: application/json'" }, { "id": "j-nJW--YrJyJwGCGdpur6", "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(\"https://developer.digitail.io/api/v1/clinic/{id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "P3XBx2E4XbRg8Y5IhUL0Y", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/clinic/{id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "jrGVqKcxT-bNvwZrLuRe_", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/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": "h_cxvekkih9e_D-gIw93d" }, "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 \"owner\": {},\n \"vets\": [\n \"\"\n ],\n \"hasGroup\": 0,\n \"group_id\": 0,\n \"rooms\": [\n \"\"\n ],\n \"reminders\": [\n \"\"\n ],\n \"meetings_link\": \"https://meetings.example.com\",\n \"token\": \"\",\n \"cash_register_notes\": \"\",\n \"sms_enabled\": false,\n \"appointment_sms\": 0,\n \"appointment_email\": 0,\n \"reminder_appointment_sms\": 0,\n \"reminder_appointment_email\": 0,\n \"reminder_health_plan_sms\": 0,\n \"reminder_health_plan_email\": 0,\n \"first_availability_not_before\": 0,\n \"has_intake\": 0,\n \"website\": \"\",\n \"gtm_id\": \"\",\n \"public_notice\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"logo\": \"\",\n \"slug\": \"\"\n }\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }