appointments

Get participants for appointment

This endpoint retrieves the participants of an appointment. Developers must provide a valid appointment_id as a path parameter, and Zocdoc returns the participants of that appointment.

get/v1/appointments/{appointment_id}/participants

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 of the appointment

Response

Success

request_idstring required

Unique request identifier for tracing

Example response

{
  "data": {
    "patient": {
      "phone_number": "9999999999",
      "email_address": "test@example.com",
      "patient_address": {
        "state": "NY"
      },
      "insurance": {
        "insurance_plan_id": "ip_31820"
      }
    }
  }
}

Changes

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