GET /v1/calendar/appointments/{appointment_id}

One appointment, with its history.

One appointment, with everything that has happened to it.

Needs the calendar:read scope.

Path parameters

Field	Type	Required	Notes
appointment_id	string	Yes	The appointment’s id.

Request

cURL

curl "https://api.fireflo.au/v1/calendar/appointments/5b0e7d3c-9a2f-4c61-8e47-1f3a6c9d2b84" \
  -H "Authorization: Bearer $OMNI_API_KEY"

Response

200 OK — the appointment, and its history, oldest first: each {kind, summary, at}, where kind is booked, rescheduled, edited, confirmed, completed, cancelled or no_show.

Field	Meaning
id	The appointment’s id.
title	What it is — the booking type’s name when it was booked.
status	requested, confirmed, completed, cancelled or no_show.
booking_type	{id, name}, or null.
contact	Who it is with: {id, name, phone}.
staff	The teammate who takes it, {name, email}.
starts_at, ends_at	When, in the account’s timezone with its offset.
mode	online or physical.
location, meeting_link	Where it happens — the place in person, the link online.
notes	The team’s notes.
source	Where it was booked: panel, inbox, agent, workflow, link (online booking) or api.
deal	The id of the deal it belongs to, with Pipelines, or null.
created_at, updated_at	When it was booked, and last changed.

status is one of:

Status	Meaning
requested	Booked, waiting to be confirmed.
confirmed	Booked and confirmed.
completed	It happened.
cancelled	It was canceled.
no_show	The contact didn’t come.

{
  "id": "5b0e7d3c-9a2f-4c61-8e47-1f3a6c9d2b84",
  "title": "Home loan consultation",
  "status": "confirmed",
  "booking_type": {
    "id": 3,
    "name": "Home loan consultation"
  },
  "contact": {
    "id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
    "name": "Ravi Kumar",
    "phone": "[phone]"
  },
  "staff": {
    "name": "Priya Sharma",
    "email": "[e-mail]"
  },
  "starts_at": "2026-10-09T11:00:00+05:30",
  "ends_at": "2026-10-09T11:30:00+05:30",
  "mode": "online",
  "location": "",
  "meeting_link": "https://meet.google.com/kfr-ptqw-xya",
  "notes": "Salaried, looking at a ₹45 lakh loan. Bring Form 16.",
  "source": "api",
  "deal": null,
  "created_at": "2026-10-06T04:12:04.512903+00:00",
  "updated_at": "2026-10-06T07:45:19.098317+00:00",
  "history": [
    {
      "kind": "booked",
      "summary": "Booked Home loan consultation with Priya Sharma for Thu 8 Oct 10:30",
      "at": "2026-10-06T04:12:04.530117+00:00"
    },
    {
      "kind": "rescheduled",
      "summary": "Moved from Thu 8 Oct 10:30 to Fri 9 Oct 11:00",
      "at": "2026-10-06T07:45:19.104552+00:00"
    }
  ]
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
404	not_found	No appointment of this account’s has that id.
404	module_off	The account’s plan doesn’t include Calendar.
403	scope_missing	The key doesn’t have the calendar:read scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.