Item Logo
Yms apiAppointment level 1

POST Search Appointments by Paging

POST Paginated Query of Appointment List

Introduction

Searches appointments with pagination support and advanced filtering capabilities. This endpoint allows querying appointments by multiple criteria including date ranges, status, carrier, customer, appointment type, and equipment details. Returns paginated results with configurable page size and sorting options. Used by operations dashboards to display appointment lists, by reporting systems for analytics, and by customer portals for appointment tracking.

API Request

POST /public/appointment/search-by-paging

Body Request Parameters

Request Parameters

Name

Location

Type

Required

Description

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

body

body

AppointmentQuery

No

none

Response Example

200 Response

Response

Status Code

Definition

Description

Data Model

200

OK

none

RPageResultAppointmentView