---
title: Get appointment by id
slug: import-test-pdf/get-appointment-by-id
createdAt: 2025-10-28T16:28:34.250Z
---
{
"id": "-alVc8jIpBHQXlLM0ro-U",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/api/v1/appointments/{id}",
"servers": [],
"name": "Get appointment by id",
"description": "Get appointment by id",
"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: patient,patient.species,patient.breed,patient.owners,room,event,service,\nclinic,clinic.rooms,vet,vet.vetRolesAll,requests,notes
"
}
],
"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/Appointment",
"customType": "Appointment",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "event_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": ""
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "room_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": ""
},
{
"name": "guest",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "pet_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "record_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": ""
},
{
"name": "status",
"kind": "optional",
"type": "integer",
"description": "`0` - Pending `1` - Pending Client Approval `2` - Pending Clinic Approval `3` - Rescheduled Clinic Approval `4` - Rescheduled Client Approval `5` - Confirmed `6` - Canceled By Client `7` - Canceled By Clinic' `8` - Automatically Created' `9` - No Show\n",
"example": 1
},
{
"name": "datetime",
"kind": "optional",
"type": "string",
"description": "",
"example": "2022-06-16 15:12:38"
},
{
"name": "end_datetime",
"kind": "optional",
"type": "string",
"description": "",
"example": "2022-06-16 15:42:38"
},
{
"name": "notify_owner",
"kind": "optional",
"type": "integer",
"description": "`0` - No Notification, `1` - Only App, `2` - Only SMS, `3` - SMS & App, `4` - Only Email, `5` - Email & App, `6` - Email & SMS, `7` - Email, SMS & App,\n",
"example": 1
},
{
"name": "observations",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "user_note",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "pet_name",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "owner_name",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "patient",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Pet",
"customType": "Pet",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "nickname",
"kind": "optional",
"type": "string",
"description": "",
"example": "Fritz"
},
{
"name": "species_id",
"kind": "optional",
"type": "string",
"description": "",
"example": "1"
},
{
"name": "breed_id",
"kind": "optional",
"type": "string",
"description": "",
"example": "1"
},
{
"name": "observations",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "gender",
"kind": "optional",
"type": "string",
"description": "",
"example": "male"
},
{
"name": "microchip",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "crossbreed",
"kind": "optional",
"type": "string<0 | 1>",
"description": "",
"example": "0"
},
{
"name": "crossbreed_details_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": ""
},
{
"name": "color",
"kind": "optional",
"type": "string",
"description": "",
"example": "NavajoWhite"
},
{
"name": "distinctive_marks",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "birthday",
"kind": "optional",
"type": "string",
"description": "",
"example": "1983-03-29"
},
{
"name": "gender_string",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "chip_number",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "microchip_location",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "insurance_number",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "passport",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "profile_picture",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2"
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "",
"example": "Lorem ipsum"
},
{
"name": "constitution",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "conformation",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "weight",
"kind": "optional",
"type": "number",
"description": "",
"example": ""
},
{
"name": "allergies",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "nr_recs",
"kind": "optional",
"type": "integer",
"description": "",
"example": ""
},
{
"name": "blood_type",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "hormonal_status",
"kind": "optional",
"type": "integer",
"description": "0: 'Unknown' 1: 'Intact' 2: 'Neutered'\n",
"example": 0
},
{
"name": "age",
"kind": "optional",
"type": "string",
"description": "",
"example": "38 Years, 3 Months, 19 Days"
},
{
"name": "patientNumber",
"kind": "optional",
"type": "string",
"description": "",
"example": "mxc-1 #jwq-1"
},
{
"name": "is_verified",
"kind": "optional",
"type": "string<0 | 1>",
"description": "",
"example": "1"
},
{
"name": "breeder",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "archive",
"kind": "optional",
"type": "object",
"description": "Slim resource for archive, usually attached to other resources",
"modelRef": "#/components/schemas/Archive",
"customType": "Archive",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"description": "",
"example": "The patient was archived because..."
},
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"example": "Deceased"
}
]
},
{
"name": "birthday_estimated",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "rabic_tag_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "12109384"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2020-06-12 15:45:43"
}
]
},
{
"name": "room",
"kind": "optional",
"type": "object",
"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": "event",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/Event",
"customType": "Event",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "address_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "capacity",
"kind": "optional",
"type": "integer",
"description": "",
"example": 25
},
{
"name": "date",
"kind": "optional",
"type": "string",
"description": "",
"example": "2022-06-16 15:12:38"
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Event Name"
},
{
"name": "preferences",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "appointments_number",
"kind": "optional",
"type": "integer",
"description": "",
"example": 5
}
]
},
{
"name": "service",
"kind": "optional",
"type": "object",
"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": "vet",
"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": "owner_email",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "owner_phone",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "reminder_notifications",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Clinic/properties/reminders/items",
"customType": "items[]",
"schema": []
},
{
"name": "newRequests",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "consentForms",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "video_link",
"kind": "optional",
"type": "string",
"description": "",
"example": "https://example.com/1234235345.mp4"
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url /api/v1/appointments/{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/appointments/{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/appointments/{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/appointments/{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 \"event_id\": 0,\n \"clinic_id\": 1,\n \"room_id\": 0,\n \"guest\": false,\n \"pet_id\": 1,\n \"record_id\": 0,\n \"status\": 1,\n \"datetime\": \"2022-06-16 15:12:38\",\n \"end_datetime\": \"2022-06-16 15:42:38\",\n \"notify_owner\": 1,\n \"observations\": \"\",\n \"user_note\": \"\",\n \"pet_name\": \"\",\n \"owner_name\": \"\",\n \"patient\": {\n \"id\": 1,\n \"nickname\": \"Fritz\",\n \"species_id\": \"1\",\n \"breed_id\": \"1\",\n \"observations\": \"\",\n \"gender\": \"male\",\n \"microchip\": \"\",\n \"crossbreed\": \"0\",\n \"crossbreed_details_id\": 0,\n \"color\": \"NavajoWhite\",\n \"distinctive_marks\": \"\",\n \"birthday\": \"1983-03-29\",\n \"gender_string\": \"\",\n \"chip_number\": \"\",\n \"microchip_location\": \"\",\n \"insurance_number\": \"\",\n \"passport\": \"\",\n \"profile_picture\": \"https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2\",\n \"description\": \"Lorem ipsum\",\n \"constitution\": \"\",\n \"conformation\": \"\",\n \"weight\": 0,\n \"allergies\": \"\",\n \"nr_recs\": 0,\n \"blood_type\": \"\",\n \"hormonal_status\": 0,\n \"age\": \"38 Years, 3 Months, 19 Days\",\n \"patientNumber\": \"mxc-1 #jwq-1\",\n \"is_verified\": \"1\",\n \"breeder\": \"\",\n \"archive\": {\n \"id\": 1,\n \"reason\": \"The patient was archived because...\",\n \"type\": \"Deceased\"\n },\n \"birthday_estimated\": false,\n \"rabic_tag_number\": \"12109384\",\n \"updated_at\": \"2020-06-12 15:45:43\"\n },\n \"room\": {\n \"id\": 1,\n \"clinic_id\": 1,\n \"name\": \"Consultation Room 1\"\n },\n \"event\": {\n \"id\": 1,\n \"address_id\": 1,\n \"clinic_id\": 1,\n \"capacity\": 25,\n \"date\": \"2022-06-16 15:12:38\",\n \"name\": \"Event Name\",\n \"preferences\": \"\",\n \"appointments_number\": 5\n },\n \"service\": {\n \"id\": 1,\n \"category_id\": 1,\n \"label\": \"General Checkup\",\n \"translation_slug\": \"services.checkups.general_checkup\"\n },\n \"vet\": {\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 \"owner_email\": \"\",\n \"owner_phone\": \"\",\n \"reminder_notifications\": [\n \"\"\n ],\n \"newRequests\": [\n {}\n ],\n \"consentForms\": [\n {}\n ],\n \"video_link\": \"https://example.com/1234235345.mp4\"\n }\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": ""
}
]
}