ZOzocdoc
appointments

Get appointment by id

This endpoint retrieves updated appointment details and the status of a single existing appointment. Developers must send a valid appointment_id as input in the request body, and Zocdoc returns the appointment details and status for that appointment. See Appointment Status definitions.

If the appointment was booked with a Zocdoc user credential, only that user will have access to view or modify the appointment. If the appointment was booked with a machine-to-machine credential, the appointment can be viewed and modified by any of the developer's machine-to-machine credentials.

get/v1/appointments/{appointment_id}

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.appointment.read
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.appointment.read

Path parameters

appointment_idstring required
Example:d04b049a-41b1-4aba-9268-d8973cf72cdd

The Zocdoc ID for the appointment.

Response

Successful

request_idstring required

Unique request identifier for tracing

Example response

{
  "data": {
    "location_phone_number": "9999999999",
    "start_time": "2022-04-27T09:00:00-04:00",
    "created_time_utc": "2024-01-01T09:30:00Z",
    "last_modified_time_utc": "2024-01-01T09:30:00Z",
    "patient_type": "new"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.