---
title: List all Visit Types Grouped by Category
slug: list-all-visit-types-grouped-by-category
docTags: 
createdAt: 2026-04-21T15:22:49.957Z
---

{
  "id": "oWPPQf635e7mmhvtNYK0e",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://developer.digitail.io/api/v1/visit-types/group-by-category",
    "servers": [
      {
        "url": "https://developer.digitail.io/api/v1/visit-types/group-by-category",
        "description": "Sandbox server (uses test data)"
      },
      {
        "url": "https://vet.digitail.io/api/v1/visit-types/group-by-category",
        "description": "Production server (uses live data)"
      }
    ],
    "name": "List all Visit Types Grouped by Category",
    "description": "<p>Permissions needed: ACCESS_ADMINISTRATION_SETTINGS</p>",
    "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": "<p>When <code>true</code> and <code>filter[clinic_id]</code> 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 <code>template_id</code> reference). Soft-deleted clinic copies do not block the corresponding group template from appearing.</p>"
        },
        {
          "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": "<p>Include additional data: printableFiles, servicePackages, instances, vets</p>"
        }
      ],
      "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": "category",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "label",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "visit_types",
                    "kind": "optional",
                    "type": "array",
                    "description": "",
                    "modelRef": "#/paths/~1api~1v1~1visit-types/get/responses/200/content/application~1json/schema/properties/data/items",
                    "customType": "items[]",
                    "schema": []
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "1JC4c9AKc9SJNxdIgz0ZZ",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://developer.digitail.io/api/v1/visit-types/group-by-category \\\n     --header 'accept: application/json'"
        },
        {
          "id": "utBZ7VW7xmCG-afWLGhsA",
          "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/group-by-category\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "jqQWgly6u17f5SYKMcZCz",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/visit-types/group-by-category\")\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": "E4tawWn6FzFOp9hIqc5TL",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/visit-types/group-by-category\"\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": "1JC4c9AKc9SJNxdIgz0ZZ"
    },
    "results": {
      "languages": [
        {
          "id": "k_-ee0cEQMf-FFz3v02AY",
          "language": "200",
          "code": "// successful operation\n{\n  \"data\": [\n    {\n      \"category\": \"\",\n      \"label\": \"\",\n      \"visit_types\": [\n        \"\"\n      ]\n    }\n  ]\n}"
        }
      ],
      "selectedLanguageId": "k_-ee0cEQMf-FFz3v02AY"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}