---
title: List all Visit Types
slug: list-all-visit-types
docTags:
createdAt: 2026-04-21T15:22:49.957Z
---
{
"id": "_XbvvJDFKuFg1_TTJR0uA",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://developer.digitail.io/api/v1/visit-types",
"servers": [
{
"url": "https://developer.digitail.io/api/v1/visit-types",
"description": "Sandbox server (uses test data)"
},
{
"url": "https://vet.digitail.io/api/v1/visit-types",
"description": "Production server (uses live data)"
}
],
"name": "List all Visit Types",
"description": "Permissions needed: ACCESS_ADMINISTRATION_SETTINGS
",
"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[clinic_group_id]",
"type": "integer",
"description": ""
},
{
"kind": "optional",
"name": "filter[is_enterprise_mode]",
"type": "boolean",
"description": "When true and filter[clinic_id] is set, returns clinic-level visit types together with group-level visit types of the clinic's group that have not yet been copied to the clinic (i.e., have no active template_id reference). Soft-deleted clinic copies do not block the corresponding group template from appearing.
"
},
{
"kind": "optional",
"name": "filter[available_for_variant_content]",
"type": "integer",
"description": ""
},
{
"kind": "optional",
"name": "filter[with_trashed_that_have_service_packages]",
"type": "boolean",
"description": ""
},
{
"kind": "optional",
"name": "include",
"type": "string",
"description": "Include additional data: printableFiles, servicePackages, instances, taskTemplates, vets
"
}
],
"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": ""
},
{
"name": "clinic_id",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": ""
},
{
"name": "clinic_group_id",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": ""
},
{
"name": "template_id",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": ""
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "category",
"kind": "optional",
"type": "string",
"description": "",
"enum": [
"consultation_exams",
"vaccines",
"preventive_vaccines",
"euthanasia",
"spay_neuter",
"medical_procedures",
"imagining_diagnostics",
"boarding",
"grooming",
"microchipping",
"other",
"admin"
]
},
{
"name": "duration",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "is_visible",
"kind": "optional",
"type": "boolean",
"description": ""
},
{
"name": "is_notifiable",
"kind": "optional",
"type": "boolean",
"description": ""
},
{
"name": "color",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "order",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": ""
},
{
"name": "deposit_for_online_booking",
"kind": "optional",
"type": "number",
"description": "",
"format": "float"
},
{
"name": "is_drop_off_enabled",
"kind": "optional",
"type": "boolean",
"description": ""
},
{
"name": "default_drop_off_time",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "09:00"
},
{
"name": "default_drop_off_vet_id",
"kind": "optional",
"type": "integer",
"nullable": true,
"description": ""
},
{
"name": "default_drop_off_vet",
"kind": "optional",
"type": "object",
"nullable": true,
"description": "",
"example": "",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "first_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "avatar",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "job_title",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"nullable": true,
"description": "",
"example": "2024-11-27T10:06:56.000000Z"
},
{
"name": "printable_files",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "service_packages",
"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": "description",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "unit_price",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "price",
"kind": "optional",
"type": "string",
"nullable": true,
"description": ""
},
{
"name": "price_include_tax",
"kind": "optional",
"type": "boolean",
"nullable": true,
"description": ""
},
{
"name": "tax",
"kind": "optional",
"type": "number",
"nullable": true,
"description": "",
"format": "float"
}
]
},
{
"name": "vets",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "first_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "avatar",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "job_title",
"kind": "optional",
"type": "string",
"description": ""
}
]
},
{
"name": "instances",
"kind": "optional",
"type": "array",
"nullable": true,
"description": "",
"modelRef": "#/paths/~1api~1v1~1visit-types/get/responses/200/content/application~1json/schema/properties/data/items",
"customType": "items[]",
"schema": []
},
{
"name": "task_templates",
"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": "links",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1plans/get/responses/200/content/application~1json/schema/properties/links",
"customType": "links",
"schema": []
},
{
"name": "meta",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta",
"customType": "meta",
"schema": []
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "twIswlHFK5Dexe55gIrl7",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://developer.digitail.io/api/v1/visit-types \\\n --header 'accept: application/json'"
},
{
"id": "m-IDL65rvdZ_YHsQhB3VX",
"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/visit-types\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "Q71hcy2-yAIYLqGJCrYDo",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/visit-types\")\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": "m7mxmhPO3eRaZOawm8ToL",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/visit-types\"\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": "twIswlHFK5Dexe55gIrl7"
},
"results": {
"languages": [
{
"id": "sq2NxnBm4VnWHKTQwRIsI",
"language": "200",
"code": "// successful operation\n{\n \"data\": [\n {\n \"id\": 0,\n \"clinic_id\": 0,\n \"clinic_group_id\": 0,\n \"template_id\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"duration\": 0,\n \"is_visible\": false,\n \"is_notifiable\": false,\n \"color\": \"\",\n \"order\": 0,\n \"deposit_for_online_booking\": \"\",\n \"is_drop_off_enabled\": false,\n \"default_drop_off_time\": \"09:00\",\n \"default_drop_off_vet_id\": 0,\n \"default_drop_off_vet\": {\n \"id\": 0,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"\",\n \"job_title\": \"\"\n },\n \"created_at\": \"2024-11-27T10:06:56.000000Z\",\n \"printable_files\": [\n {\n \"id\": 0,\n \"title\": \"\"\n }\n ],\n \"service_packages\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"unit_price\": \"\",\n \"price\": \"\",\n \"price_include_tax\": false,\n \"tax\": \"\"\n }\n ],\n \"vets\": [\n {\n \"id\": 0,\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"avatar\": \"\",\n \"job_title\": \"\"\n }\n ],\n \"instances\": [\n \"\"\n ],\n \"task_templates\": [\n {\n \"id\": 0,\n \"name\": \"\"\n }\n ]\n }\n ],\n \"links\": {},\n \"meta\": {}\n}"
}
],
"selectedLanguageId": "sq2NxnBm4VnWHKTQwRIsI"
}
},
"children": [
{
"text": ""
}
]
}