> ## Documentation Index > Fetch the complete documentation index at: https://docs.maxcare.ai/llms.txt > Use this file to discover all available pages before exploring further. # List appointment types > Returns the appointment types configured for the organization, across every connected EHR instance. COMPLETENESS DIFFERS BY EHR: for ModMed the catalogue is fetched from the practice's configuration and is complete, including types nobody has booked. For EZDerm it is derived from types observed on synced appointments, so a type with no appointment in the sync window is absent and `durationMinutes` is null. Requires read:appointments or read:schedule scope. ## OpenAPI ````yaml /openapi-v1.json get /appointment-types openapi: 3.0.0 info: title: Max AI Public API description: API for third-party marketplace apps version: '1.0' contact: {} servers: - url: https://api.maxcare.ai/v1 security: [] tags: [] paths: /appointment-types: get: tags: - Appointment Types summary: List appointment types description: >- Returns the appointment types configured for the organization, across every connected EHR instance. COMPLETENESS DIFFERS BY EHR: for ModMed the catalogue is fetched from the practice's configuration and is complete, including types nobody has booked. For EZDerm it is derived from types observed on synced appointments, so a type with no appointment in the sync window is absent and `durationMinutes` is null. Requires read:appointments or read:schedule scope. operationId: AppointmentTypesPublicController_listAppointmentTypes parameters: - name: inUseOnly required: false in: query description: >- When true, return only types seen on at least one synced appointment. Useful for building a filter picker that offers nothing which would match zero appointments. schema: example: false type: boolean - name: activeOnly required: false in: query description: >- When true, return only types the practice can still book. Retired types are returned by default because historical appointments still reference them. ModMed only — EZDerm reports no status, so EZDerm types have `active: null` and are EXCLUDED by this filter. schema: example: false type: boolean - name: X-Organization-Id in: header required: true schema: type: string description: Target clinic organization ID responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAppointmentTypesSuccessResponse' '401': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/PublicApiUnauthorizedResponse' '403': description: Insufficient scope content: application/json: schema: $ref: '#/components/schemas/PublicApiForbiddenResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/PublicApiRateLimitResponse' security: - api-key: [] components: schemas: ListAppointmentTypesSuccessResponse: type: object properties: code: type: string description: Response code example: success data: $ref: '#/components/schemas/ListAppointmentTypesResponseData' required: - code - data PublicApiUnauthorizedResponse: type: object properties: code: type: string description: Error code example: unauthorized message: type: string description: Human-readable error message example: Invalid or missing API key trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id PublicApiForbiddenResponse: type: object properties: code: type: string description: Error code example: forbidden message: type: string description: Human-readable error message example: Insufficient scope trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id PublicApiRateLimitResponse: type: object properties: code: type: string description: Error code example: rate_limit_exceeded message: type: string description: Human-readable error message example: Rate limit exceeded. Maximum 1000 requests per 60 seconds. trace_id: type: string description: Trace ID for debugging example: 550e8400-e29b-41d4-a716-446655440000 required: - code - message - trace_id ListAppointmentTypesResponseData: type: object properties: appointmentTypes: type: array items: $ref: '#/components/schemas/ExternalAppointmentTypeResponse' required: - appointmentTypes ExternalAppointmentTypeResponse: type: object properties: id: type: string description: >- Max AI's own id for this appointment type. Pass THIS to `GET /appointments?appointmentTypeIds=`, not `externalId` — an EHR-native type id is only unique within one EHR instance, so on an organization with two connected instances the same `externalId` names two different types. Prefixed `atp_…` from v3 onward; a raw UUID on v1/v2. example: 9f1c2d3e-4b5a-46f7-8901-234567890abc externalId: type: string description: >- The EHR's own id for this type, as it appears in the EHR. Useful for reconciling against the practice's own configuration screens. NOT unique across EHR instances — do not use it as a key. example: '6054' instanceId: type: string description: >- The EHR instance this type belongs to. Two types can share a `name` and an `externalId` while belonging to different instances; this is what tells them apart. Prefixed `ins_…` from v3 onward; a raw UUID on v1/v2. example: 1a2b3c4d-5e6f-47a8-9b01-c2d3e4f56789 name: type: string description: Display name nullable: true example: Follow-up, established abbreviation: type: string description: Short code, when the EHR exposes one. Always null for EZDerm. nullable: true example: EST durationMinutes: type: number description: >- The type's configured default length in minutes. Null for EZDerm, whose catalogue is derived from observed appointments and carries no configured default. nullable: true example: 15 cosmetic: type: boolean description: >- EZDerm-only flag marking the type as cosmetic rather than medical. Null for ModMed. nullable: true example: false active: type: boolean description: >- Whether the practice can still book this type. Null for EZDerm, whose catalogue is derived from observed appointments and carries no status. nullable: true example: true lastSyncedAt: type: string description: When Max AI last saw this type in the practice's configuration. example: '2026-07-31T04:15:00.000Z' required: - id - externalId - instanceId - name - abbreviation - durationMinutes - cosmetic - active - lastSyncedAt securitySchemes: api-key: scheme: bearer bearerFormat: JWT type: http description: Marketplace API key ````