---
title: Get appointments report
slug: get-appointments-report
docTags:
createdAt: 2026-04-21T15:22:49.957Z
---
{
"id": "pAgwUDNiLuMDX6c5iEPkM",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://developer.digitail.io/api/v1/reports/appointments",
"servers": [
{
"url": "https://developer.digitail.io/api/v1/reports/appointments",
"description": "Sandbox server (uses test data)"
},
{
"url": "https://vet.digitail.io/api/v1/reports/appointments",
"description": "Production server (uses live data)"
}
],
"name": "Get appointments report",
"description": "Get appointments report",
"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": "filter[vet_id]",
"type": "string",
"description": "Filter by vet ID"
},
{
"kind": "optional",
"name": "filter[source]",
"type": "string",
"description": "0 - Clinic 1 - Web 2 - App
"
},
{
"kind": "optional",
"name": "filter[status]",
"type": "string",
"description": "",
"enum": [
"created_by_vet",
"requested_by_user",
"rescheduled_by_vet",
"requested_reschedule_by_user",
"confirmed",
"canceled_by_user",
"canceled_by_vet",
"auto_created",
"no_show",
"pending",
"completed"
]
},
{
"kind": "optional",
"name": "filter[date_between]",
"type": "array",
"description": "Dates Between (start_date, end_date), format: YYYY-MM-DD
",
"schema": [],
"itemType": "string",
"customType": "string[]"
},
{
"kind": "optional",
"name": "filter[visit_type_id]",
"type": "string",
"description": "Filter by visit type ID"
},
{
"kind": "optional",
"name": "filter[has_payment_deposits]",
"type": "boolean",
"description": "Return only the appointments that have or not payment deposits(Ex: 0 - false; 1 - true;)
"
},
{
"kind": "optional",
"name": "sort",
"type": "string",
"description": "Sorting(ex: 'datetime_start_utc', 'datetime_end_utc', 'clinic_id', 'vet_id')
"
}
],
"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": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "datetime_start_utc",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-12-01T09:00:00.000000Z",
"format": "date-time"
},
{
"name": "datetime_end_utc",
"kind": "optional",
"type": "string",
"description": "",
"example": "2023-12-01T10:00:00.000000Z",
"format": "date-time"
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"created_by_vet",
"requested_by_user",
"rescheduled_by_vet",
"requested_reschedule_by_user",
"confirmed",
"canceled_by_user",
"canceled_by_vet",
"auto_created",
"no_show",
"pending",
"completed"
]
},
{
"name": "source",
"kind": "optional",
"type": "integer",
"description": "0 - Vet 1 - Pet Parent 2 - Mobile
"
},
{
"name": "pet",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "nickname",
"kind": "optional",
"type": "string",
"description": "",
"example": "Ben"
},
{
"name": "species",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1species/get/responses/200/content/application~1json/schema/properties/data/items",
"customType": "items",
"schema": []
},
{
"name": "breed",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1breeds/get/responses/200/content/application~1json/schema/properties/data/items",
"customType": "items",
"schema": []
},
{
"name": "pet_parents",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "address",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "address_2",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "chat_uid",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
}
]
},
{
"name": "age",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "archive",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "Archive details for an archived pet, in the shape returned by the report resources (App\\Http\\Resources\\Reports\\Shared\\PetArchiveResource). Drives the frontend archived badge / legacy name emoji.
",
"example": "",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"example": "Deceased",
"enum": [
"Deceased",
"Moved away",
"Change of owner",
"Other"
]
},
{
"name": "archived_at",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "2026-01-12T00:00:00.000000Z"
},
{
"name": "reason",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "The patient was archived because..."
}
]
},
{
"name": "patient",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "number",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "clinic",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "vet",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "first_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "job_title",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "payment_deposits",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "value",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "paid_value",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "status",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"paid",
"pending",
"partially_paid"
]
},
{
"name": "appointments",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/paths/~1api~1v1~1reports~1appointments/get/responses/200/content/application~1json/schema/properties/data/items",
"customType": "items[]",
"schema": []
},
{
"name": "payment_links",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "amount",
"kind": "optional",
"type": "string",
"description": "",
"format": "float"
},
{
"name": "url",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
},
{
"name": "guest",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "pet_name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": ""
},
{
"name": "pet_parent_name",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": ""
},
{
"name": "pet_parent_email",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": ""
},
{
"name": "pet_parent_phone",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": ""
},
{
"name": "revenue",
"kind": "optional",
"type": "string",
"description": "",
"format": "float"
},
{
"name": "utm_source",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "services",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "last_confirmed_at",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "2023-12-01T09:00:00.000000Z",
"format": "date-time"
},
{
"name": "confirmed_by",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "client",
"enum": [
"client",
"staff"
]
},
{
"name": "confirmation_source",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "sms_reminder",
"enum": [
"phone",
"sms_reminder",
"email_reminder",
"pet_portal",
"public_calendar",
"crm"
]
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "I6cjpLGbKJaFKLPVNK4dy",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/reports/appointments \\\n --header 'accept: application/json'"
},
{
"id": "62Kz6Y1pbLL6-6ZOOIXH9",
"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/reports/appointments\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "RkFbOjRHr5WQEO61_XvkV",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/reports/appointments\")\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": "jsZXoiOWb7Qc3r9Rs2z8R",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/reports/appointments\"\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": "I6cjpLGbKJaFKLPVNK4dy"
},
"results": {
"languages": [
{
"id": "4knbVetl9WQpCwcRqvDQ2",
"language": "200",
"code": "// successful operation\n{\n \"data\": [\n {\n \"id\": 1,\n \"datetime_start_utc\": \"2023-12-01T09:00:00.000000Z\",\n \"datetime_end_utc\": \"2023-12-01T10:00:00.000000Z\",\n \"status\": \"\",\n \"source\": 0,\n \"pet\": {\n \"id\": 1,\n \"nickname\": \"Ben\",\n \"species\": {},\n \"breed\": {},\n \"pet_parents\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"last_name\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"address_2\": \"\",\n \"email\": \"\",\n \"chat_uid\": \"\"\n }\n ],\n \"age\": \"\",\n \"archive\": {\n \"type\": \"Deceased\",\n \"archived_at\": \"2026-01-12T00:00:00.000000Z\",\n \"reason\": \"The patient was archived because...\"\n },\n \"patient\": {\n \"id\": 0,\n \"clinic_id\": 0,\n \"number\": \"\"\n }\n },\n \"clinic\": {\n \"id\": 1,\n \"name\": \"\"\n },\n \"vet\": {\n \"id\": 1,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"job_title\": \"\"\n },\n \"payment_deposits\": {\n \"id\": 0,\n \"value\": \"\",\n \"paid_value\": \"\",\n \"status\": \"\",\n \"appointments\": [\n \"\"\n ],\n \"payment_links\": [\n {\n \"id\": 0,\n \"amount\": \"\",\n \"url\": \"\"\n }\n ]\n },\n \"guest\": false,\n \"pet_name\": \"\",\n \"pet_parent_name\": \"\",\n \"pet_parent_email\": \"\",\n \"pet_parent_phone\": \"\",\n \"revenue\": \"\",\n \"utm_source\": \"\",\n \"services\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ],\n \"last_confirmed_at\": \"2023-12-01T09:00:00.000000Z\",\n \"confirmed_by\": \"client\",\n \"confirmation_source\": \"sms_reminder\"\n }\n ]\n}"
}
],
"selectedLanguageId": "4knbVetl9WQpCwcRqvDQ2"
}
},
"children": [
{
"text": ""
}
]
}