---
updatedAt: 2026-06-09T10:44:05.000Z
agentTools:
  projectIndex: https://developer.phorest.com/llms.txt
---

# Retrieve an appointment

Retrieve an appointment for the specified business id, branch id and appointment id

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Third Party API",
    "description": "This API allow third parties to integrate with Phorest internal core services such as core, online-booking, planner, etc. Please, see the <a href=\"http://dev-changelog.s3-website-eu-west-1.amazonaws.com/?prefix=/third-party-api-server/\" target=\"_blank\">CHANGELOG</a> for further information on API updates.",
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.45.0"
  },
  "servers": [
    {
      "url": "http://api-gateway-eu.phorest.com/third-party-api-server",
      "description": "If you are from Europe, use this server"
    },
    {
      "url": "http://api-gateway-us.phorest.com/third-party-api-server",
      "description": "If you are from United States, Canada or Australia, use this server"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "tags": [
    {
      "name": "Appointment",
      "description": "Appointment Controller"
    }
  ],
  "paths": {
    "/api/business/{businessId}/branch/{branchId}/appointment/{appointmentId}": {
      "get": {
        "tags": [
          "Appointment"
        ],
        "summary": "Retrieve an appointment",
        "description": "Retrieve an appointment for the specified business id, branch id and appointment id",
        "operationId": "getAppointment",
        "parameters": [
          {
            "name": "businessId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "branchId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "appointmentId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Specified appointment retrieved",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AppointmentResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Business, branch or appointment with the specified ids don't exist",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Request rate limit exceeded. Current limit set to 100 rps.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "integer",
            "format": "int32"
          },
          "id": {
            "type": "string"
          },
          "detail": {
            "type": "string"
          },
          "errorCode": {
            "type": "string"
          }
        }
      },
      "AppointmentResponse": {
        "required": [
          "appointmentId",
          "staffId",
          "startTime",
          "version"
        ],
        "type": "object",
        "properties": {
          "appointmentId": {
            "type": "string",
            "example": "ab123"
          },
          "version": {
            "type": "integer",
            "format": "int64",
            "example": 1
          },
          "appointmentDate": {
            "type": "string",
            "example": "2018-01-01"
          },
          "startTime": {
            "type": "string",
            "example": "09:00:00"
          },
          "endTime": {
            "type": "string",
            "description": "If the staff/service is changed then the duration is calculated from the new staff/service and endTime is ignored. Otherwise the endTime given is used.",
            "example": "09:30:00"
          },
          "price": {
            "type": "number",
            "example": 40
          },
          "staffId": {
            "type": "string",
            "example": "staffid"
          },
          "roomId": {
            "type": "string",
            "example": "roomid"
          },
          "machineId": {
            "type": "string",
            "example": "machineid"
          },
          "confirmed": {
            "type": "boolean",
            "example": true
          },
          "serviceId": {
            "type": "string",
            "example": "serviceid"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "staffRequest": {
            "type": "boolean",
            "example": true
          },
          "preferredStaff": {
            "type": "boolean",
            "example": true
          },
          "clientId": {
            "type": "string",
            "example": "clientid"
          },
          "serviceRewardId": {
            "type": "string",
            "example": "servicerewardid"
          },
          "courseId": {
            "type": "string",
            "example": "courseId"
          },
          "courseName": {
            "type": "string",
            "example": "courseName"
          },
          "clientCourseId": {
            "type": "string",
            "example": "clientCourseId"
          },
          "clientCourseItemId": {
            "type": "string",
            "example": "clientcourseitemid"
          },
          "purchasingBranchId": {
            "type": "string",
            "example": "purchasingBranchId"
          },
          "serviceGroupItemOptionId": {
            "type": "string",
            "example": "servicegroupitemoptionid"
          },
          "serviceGroupId": {
            "type": "string",
            "example": "servicegroupid"
          },
          "parentServiceGroupId": {
            "type": "string",
            "description": "This is the id of a service group at a business level and corresponds to the service group id used in the booking apis",
            "example": "parentservicegroupid"
          },
          "serviceName": {
            "type": "string",
            "example": "serviceName"
          },
          "state": {
            "type": "string",
            "example": "BOOKED",
            "enum": [
              "BOOKED",
              "CHECKED_IN",
              "PAID"
            ]
          },
          "activationState": {
            "type": "string",
            "example": "ACTIVE",
            "enum": [
              "RESERVED",
              "ACTIVE",
              "CANCELED"
            ]
          },
          "waitingListDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "depositAmount": {
            "type": "number",
            "example": 20
          },
          "depositDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "bookingId": {
            "type": "string",
            "example": "bookingid"
          },
          "source": {
            "type": "string",
            "example": "source"
          },
          "groupBookingId": {
            "type": "string",
            "example": "groupbookingid"
          },
          "deleted": {
            "type": "boolean",
            "example": true
          },
          "notes": {
            "type": "string",
            "example": "This is a note about the appointment"
          },
          "internetServiceCategories": {
            "type": "array",
            "description": "Contains list of the ID and name of an internet service category that a service belongs to. This data is available only if <code>fetch_online_category</code> parameter is set to true",
            "items": {
              "$ref": "#/components/schemas/InternetServiceCategory"
            }
          },
          "branchId": {
            "type": "string",
            "example": "X9QpRsZ3bSvhJAaakg9TXQ"
          },
          "isFinishAppointment": {
            "type": "boolean",
            "description": "Indicates if this appointment is the concluding segment of a split service."
          }
        }
      },
      "InternetServiceCategory": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true,
            "example": "ab123"
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "example": "Cut & Style"
          }
        },
        "description": "Contains list of the ID and name of an internet service category that a service belongs to. This data is available only if <code>fetch_online_category</code> parameter is set to true"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  }
}
```