---
updatedAt: 2025-09-17T22:50:39.000Z
agentTools:
  projectIndex: https://developer.maximizer.com/v1.6/llms.txt
---

# Get a drop-down list of appointment results

> 🚧 Notice to Ferret API (v1) users
>
> We’re excited to announce the beta release of [Ferret API v2](https://developer.maximizer.com/v2/reference/ferret-api), offering a more consistent and expanded approach, with access to a wider range of objects.
>
> New clients are encouraged to start with [Ferret API v2](https://developer.maximizer.com/v2/reference/ferret-api) and/or [Octopus API](https://developer.maximizer.com/v2/reference/octopus-api) to take advantage of the latest updates. Existing clients are also encouraged to transition to v2, although Ferret API v1 will remain stable and fully operational. For those looking to migrate to the Octopus API, we’ve prepared [a detailed migration guide](https://developer.maximizer.com/v2/docs/migration-guide-ferret-v1-to-octopus-api).

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Ferret API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.maximizer.com/ferret/"
    }
  ],
  "paths": {
    "/v1/appointments/results/drop-down": {
      "get": {
        "tags": [
          "Appointments"
        ],
        "summary": "Get a drop-down list of appointment results",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/TimelineResultDropDownItemDropDownResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimelineResultDropDownItemDropDownResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/TimelineResultDropDownItemDropDownResult"
                }
              }
            }
          }
        },
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "TimelineResultDropDownItem": {
        "type": "object",
        "properties": {
          "legacyKey": {
            "type": "string",
            "description": "Result legacy key",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "Result name",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Timeline's result drop-down item"
      },
      "TimelineResultDropDownItemDropDownResult": {
        "type": "object",
        "properties": {
          "query": {
            "type": "string",
            "description": "Requested term",
            "nullable": true
          },
          "totalCount": {
            "type": "integer",
            "description": "Amount of found items",
            "format": "int32"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TimelineResultDropDownItem"
            },
            "description": "Drop-down items",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Drop-down result"
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "apiKey",
        "description": "JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\"",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```