---
title: "List Appointment Details"
method: GET
path: "/appointment_details"
tags: ["Appointment Details"]
---

# List Appointment Details

`GET /appointment_details`

Retrieve a list of appointment data with custom fields

## Query parameters

- `id` string
- `created_at` string
- `updated_at` string
- `organisation_id` string
- `name` string
- `description` string
- `external_id` string
- `status_key` string
- `type_key` string
- `assignee_id` string
- `contact_id` string
- `start_time` string
- `end_time` string
- `confirmed_at` string
- `cancelled_at` string
- `location_id` string
- `select` string
- `order` string
- `offset` string
- `limit` string

## Headers

- `Range` string
- `Range-Unit` string

## Response `200`

OK

- AppointmentDetails[]
  - `id` string, uuid — Appointment ID
  - `created_at` string, timestamp with time zone — Creation date
  - `updated_at` string, timestamp with time zone — Latest update
  - `organisation_id` string, uuid — Organisation ID
  - `name` string, text — Name of the appointment
  - `description` string, text, nullable — Description of the appointment
  - `external_id` string, text, nullable — External ID
  - `status_key` string, text — Status Key
  - `type_key` string, text — Type Key
  - `assignee_id` string, uuid, nullable — Assignee ID
  - `contact_id` string, uuid — Contact ID
  - `start_time` string, timestamp with time zone — Start time of the appointment
  - `end_time` string, timestamp with time zone, nullable — End time of the appointment
  - `confirmed_at` string, timestamp with time zone, nullable — Confirmed at timestamp
  - `cancelled_at` string, timestamp with time zone, nullable — Cancelled at timestamp
  - `location_id` string, uuid, nullable — Location ID

---

[API](https://skmtc.dev/getmateo/apis/mateo-api.md) · [All operations](https://skmtc.dev/getmateo/apis/mateo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getmateo/mateo-api/revisions/22a9b3b009d1/schema)