Item Logo
Yms apiAppointment level 1

GET Get Appointment Details

GET Get Appointment Details

Introduction

Retrieves detailed information for a specific appointment by its unique identifier. This endpoint returns comprehensive appointment data including scheduled times, carrier and customer details, inbound/outbound actions, current status, and associated equipment information. Used by operations staff to view appointment details, by gate personnel to verify scheduled visits, and by customer-facing applications to display booking information.

API Request

GET /public/appointment/{appointmentId}

Request Parameters

Name

Location

Type

Required

Description

appointmentId

path

string

Yes

Appointment ID

X-Tenant-ID

header

string

No

none

X-Yard-ID

header

string

No

none

Item-Time-Zone

header

string

No

none

Authorization

header

string

No

none

Response Example

200 Response

Response

Status Code

Definition

Description

Data Model

200

OK

none

RAppointmentView