---
title: "Get an appointment by ID"
method: GET
path: "/v3/diary/{shortName}/appointment"
tags: ["DiaryController"]
---

# Get an appointment by ID

`GET /v3/diary/{shortName}/appointment`

## Path parameters

- `shortName` string, required

## Query parameters

- `appointmentID` string, required

## Response `200`

OK

- DiaryAppointmentModel — Represents a single diary appointment for a staff member.
  - `OID` string — The unique Object ID (OID).
  - `ETag` string — A unique identifier defining the object and change revision.
  - `CreatedAt` string, date-time — The date/time this appointment was created.
  - `Start` string, date-time — The start date/time of this appointment.
  - `End` string, date-time — The end date/time of this appointment.
  - `Subject` string — The appointment subject text.
  - `Comment` string — The appointment comments text.
  - `Staff` string — The staff member holding this appointment.
  - `CreatedBy` string — The staff member that created this appointment.
  - `Cancelled` boolean — Whether the appointment has been cancelled.
  - `AppointmentType` string — The diary appointment type.
  - `RemindAt` string, date-time — The date/time to remind the staff member of this appointment.
  - `RemindBefore` 'Min' | 'Min2' | 'Min5' | 'Min10' | 'Min15' | 'Min30' | 'Min45' | 'Hour' | 'Hour2' | 'Hour3' | 'Hour6' | 'Hour12' | 'Day' | 'Day2' | 'Day3' | 'Week' | 'NoReminder' — The number of minutes before the appointment start date/time to remind the staff member. -1 means don't remind.
  - `LinkedProperties` LinkedPropertiesModel[] — A collection of properties linked to the appointment:-
    - `OID` string — OID
    - `ETag` string — ETag
    - `AddressNumber` string — Address Number
    - `AddressFlatRoomNumber` string — Address Flat Room Number
    - `Address1` string — Address 1
    - `Address2` string — Address2
    - `Address3` string — Address 3
    - `Address4` string — Address 4
    - `Postcode` string — Postcode
    - `MainLandlord` LinkedLandlordModel — Holds information on landlords
      - `OID` string — OID
      - `ETag` string — ETag
      - `Title` string — Title
      - `Forename` string — Forename
      - `Surname` string — Surname
      - `PhoneNumber` string — Landlord's phone number
      - `Email` string — Landlord's email address
    - `LatestTenancy` LatestTenancyModel — Holds information on the most recent tenancy linked to the property.
      - `OID` string — OID
      - `ETag` string — ETag
      - `GlobalReference` string — The unique global reference of the Tenancy
      - `StartDate` string, date-time — The start date of the Tenancy
      - `FixedDate` string, date-time — The fixed date of the Tenancy
      - `EndDate` string, date-time — The end date of the Tenancy
      - `IsTenancyProposed` boolean — Is the tenancy Proposed?
      - `IsTenancySigned` boolean — Is the tenancy signed?
      - `IsTenancyEnded` boolean — Has the Tenancy ended?
      - `LinkedTenants` LinkedTenantModel[] — A collection of tenants linked to the tenancy:-
        - `OID` string — OID
        - `ETag` string — ETag
        - `Title` string — Title
        - `Forename` string — Forename
        - `Surname` string — Surname
        - `PhoneNumber` string — Tenant's phone number
        - `Email` string — Tenant's email address
      - `AccessArrangements` string — Access Arrangements
      - `AccessName1` string — Arrange access contact name 1
      - `AccessName2` string — Arrange access contact name 2
      - `AccessName3` string — Arrange access contact name 3
      - `AccessMobile1` string — Arrange access Mobile 1
      - `AccessMobile2` string — Arrange access Mobile 2
      - `AccessMobile3` string — Arrange access Mobile 3
  - `LinkedGuest` LinkedGuestModel[] — Linked Guest Model:-
    - `OID` string — Guest OID:-
    - `GlobalReference` string — Guest Global Reference:-
    - `CreatedAt` string, date-time — Guest Created At:-
    - `Name` string — Guest Name:-
    - `Email` string — Guest Email:-
    - `Mobile` string — Guest Mobile:-
  - `Recurrence` integer — The reccurrence interval for the appointment:-
  - `RecurrenceType` string — The type of recurrence:-
  - `NextRecurringDate` string, date-time — Date appointment next repeats:-

---

[API](https://skmtc.net/letmc/apis/agentos-api-v3-diary-call-group.md) · [All operations](https://skmtc.net/letmc/apis/agentos-api-v3-diary-call-group/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/letmc/agentos-api-v3-diary-call-group/versions/9e518bf9a2f6/schema)