Filter Appointments

Filter the authenticated customer's appointments with the standard v2 filter/order_by/page body. Any response field — including dotted paths into related records, e.g. uuid, status, scheduled_start_dt, distribution_center.code, domestic_shipment.uuid, domestic_shipment.shipment_id, import_drayage.uuid — can be used in filter conditions, except container.*: use the top-level container_uuid parameter, which matches the container whether it is linked to the appointment directly or through its import drayage.

All datetimes are FC-local and naive: filter values are compared as local time and timestamps are echoed back exactly as stored (no Z, no offset).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Generic filter body for appointments, plus one convenience lookup.

container_uuid exists as a top-level parameter (rather than a
container.uuid filter condition) because an appointment links its
container either directly or via the import drayage leg — the parameter
matches both, which a plain filter condition cannot express.

integer
≥ 0
Defaults to 0
integer
1 to 75
Defaults to 50
OrderBy | null
FilterGroup | null

Return appointments for this container, whether it is linked to the appointment directly or through its import drayage. Use this instead of a container.* filter condition.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json