> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecobalt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Appointment by ID

> Gets details for a specific appointment.

### Example Request

```bash theme={null}
curl -X GET https://api.usecobalt.com/v1/appointments/1276397812 \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH'
```

### Example Response

```json theme={null}
{
    "success": true,
    "appointment": {
        "id": "1276397812",
        "datetime": "2024-03-14T00:00:00-07:00",
        "appointment_mode": "office",
        "appointment_type": "f/u",
        "location": "54252",
        "patient_name": "Jane Doe",
        "patient_mrn": "414421",
        "patient_dob": "1994-08-12",
        "patient_gender": "female",
        "insurance": "Blue Shield",
        "insurance_subscriber": "John Doe",
        "insurance_number": "19228934",
        "insurance_group_number": "FDL992829qe",
        "reason": "Routine follow-up",
        "provider_ehr_id": "6644",
        "provider_npi": "2453453453",
        "status": "completed"
    }
}
```


## OpenAPI

````yaml GET /appointments/{id}
openapi: 3.0.0
info:
  title: Cobalt API
  version: 1.0.1
  description: API for interacting with Cobalt's EHR integration services
servers:
  - url: https://api.usecobalt.com/v1
security:
  - ClientCredentials: []
    ClientSecret: []
    AccessToken: []
paths:
  /appointments/{id}:
    get:
      summary: Get Appointment
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: The appointment ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  appointment:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Cobalt appointment ID (UUID with hyphens stripped).
                      ehr_appointment_id:
                        type: string
                        description: >-
                          The appointment's identifier in the source EMR.
                          Deprecated alias of emr_appointment_id.
                      emr_appointment_id:
                        type: string
                        description: The appointment's identifier in the source EMR.
                      datetime:
                        type: string
                        format: date-time
                        description: >-
                          Appointment start time as an ISO 8601 timestamp in the
                          user's configured timezone.
                      duration:
                        type: number
                        description: Appointment duration in minutes.
                      status:
                        type: string
                        description: >-
                          Current appointment status (e.g., "scheduled",
                          "checked_in", "completed", "cancelled").
                      appointment_type:
                        type: string
                        description: >-
                          EHR-defined appointment type (e.g., "New Patient
                          Visit", "Follow-up").
                      appointment_mode:
                        type: string
                        enum:
                          - office
                          - telemedicine
                        description: Whether the visit is in-office or telemedicine.
                      location:
                        type: string
                        nullable: true
                        description: >-
                          EHR location identifier where the appointment is
                          scheduled.
                      practice_id:
                        type: string
                        nullable: true
                        description: EHR practice identifier, when applicable.
                      reason:
                        type: string
                        nullable: true
                        description: The appointment booking reason, when available.
                      complaint_type:
                        type: string
                        nullable: true
                        description: >-
                          Chief complaint or visit reason category, when
                          available.
                      patient_name:
                        type: string
                        description: >-
                          Raw patient identifier as stored by the source EHR
                          (often formatted as "Last, First"). For a clean
                          first/last split, use `patient_first_name` and
                          `patient_last_name` instead.
                      patient_first_name:
                        type: string
                        description: >-
                          Patient first name. Omitted from the response when not
                          available.
                      patient_last_name:
                        type: string
                        description: >-
                          Patient last name. Omitted from the response when not
                          available.
                      patient_mrn:
                        type: string
                        description: The patient's Medical Record Number.
                      patient_ehr_id:
                        type: string
                        description: >-
                          The patient's identifier in the source EHR. May equal
                          `patient_mrn` for EHRs that do not distinguish the
                          two.
                      patient_dob:
                        type: string
                        nullable: true
                        description: Patient date of birth (YYYY-MM-DD).
                      patient_gender:
                        type: string
                        nullable: true
                        description: Patient sex/gender as recorded in the EHR.
                      patient_phone:
                        type: string
                        description: >-
                          Patient phone number. Omitted from the response when
                          not available.
                      provider_ehr_id:
                        type: string
                        nullable: true
                        description: Primary provider's identifier in the source EHR.
                      provider_name:
                        type: string
                        nullable: true
                        description: >-
                          Primary provider's display name, resolved from
                          Cobalt's provider directory.
                      provider_npi:
                        type: string
                        description: >-
                          Primary provider's NPI. Omitted from the response when
                          not on file.
                      secondary_provider_ehr_id:
                        type: string
                        nullable: true
                        description: >-
                          Secondary provider's identifier in the source EHR,
                          when applicable.
                      insurance:
                        type: string
                        nullable: true
                        description: Primary insurance plan name.
                      insurance_number:
                        type: string
                        nullable: true
                        description: Primary insurance member/policy number.
                      insurance_group_number:
                        type: string
                        nullable: true
                        description: Primary insurance group number.
                      insurance_subscriber:
                        type: string
                        nullable: true
                        description: Primary insurance subscriber name.
                      secondary_insurance:
                        type: string
                        nullable: true
                        description: Secondary insurance plan name, when present.
                      secondary_insurance_number:
                        type: string
                        nullable: true
                        description: >-
                          Secondary insurance member/policy number, when
                          present.
                      insurances:
                        nullable: true
                        description: >-
                          Structured list of all insurance plans on file for the
                          appointment, when available.
                        oneOf:
                          - type: array
                            items:
                              type: object
                          - type: object
                      diagnoses:
                        nullable: true
                        description: >-
                          Structured diagnosis data captured for the visit, when
                          available.
                        oneOf:
                          - type: array
                            items:
                              type: object
                          - type: object
                      medications:
                        nullable: true
                        description: >-
                          Structured medication data captured for the visit,
                          when available.
                        oneOf:
                          - type: array
                            items:
                              type: object
                          - type: object
                      note:
                        type: string
                        description: Appointment note text.
                      progress_note:
                        type: string
                        nullable: true
                        description: Progress note content for the visit, when available.
                      created_at:
                        type: string
                        format: date-time
                        description: When the appointment row was first created in Cobalt.
                      object_metadata:
                        type: object
                        description: >-
                          Provenance metadata describing how this appointment
                          record was created.
                        properties:
                          source:
                            type: string
                            enum:
                              - cobalt_operation
                              - ehr_sync
                              - unknown
                            description: >-
                              `cobalt_operation` if Cobalt created the
                              appointment, `ehr_sync` if it was ingested from
                              the EHR, `unknown` otherwise.
                          created_at:
                            type: string
                            format: date-time
                            description: >-
                              When the creating Cobalt operation completed. Only
                              present when `source` is `cobalt_operation`.
components:
  securitySchemes:
    ClientCredentials:
      type: apiKey
      in: header
      name: client_id
    ClientSecret:
      type: apiKey
      in: header
      name: client_secret
    AccessToken:
      type: apiKey
      in: header
      name: access_token

````