Sign in
bookings

List Bookings Endpoint

Canonical bookings list. Default scope is Active (confirmed + on-hold); pass status_code explicitly for the Cancelled view.

get/api/v1/bookings

Query parameters

propertystring[] nullable
originating_channelOriginatingChannel[] nullable
property_excludestring[] nullable
originating_channel_excludeOriginatingChannel[] nullable
wh_source_idstring nullable
channelstreamboolean nullable
status_codeBookingStatusCode[] nullable
originIngestionSource[] nullable
attribution_tierAttributionTier[] nullable
booked_fromstring date-time nullable
booked_tostring date-time nullable
stay_fromstring date nullable
stay_tostring date nullable
cancelled_fromstring date-time nullable
cancelled_tostring date-time nullable
discrepancy'feed_conflicts_human'

Booking-anchored discrepancy filter values (PR 6/PR 7).

judged_without_reservation is log-anchored (a stamped log with NO canonical reservation) and therefore lives on the logs surface — a bookings list cannot show a booking that doesn't exist.

unknown_commissionboolean nullable
limitinteger nullable
offsetinteger nullable
pageinteger nullable

Deprecated - use offset.

Deprecated - use offset.

per_pageinteger nullable

Deprecated - use limit.

Deprecated - use limit.

start_datestring date nullable
end_datestring date nullable
date_fieldstring nullable

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

date_fromstring date-time nullable

Deprecated - use start_date.

Deprecated - use start_date.

date_tostring date-time nullable

Deprecated - use end_date.

Deprecated - use end_date.

use_created_atboolean nullable

Deprecated - use date_field=created_at.

Deprecated - use date_field=created_at.

property_idsstring[] nullable
property_ids_excludestring[] nullable
include_considered_hotelsboolean nullable

Include hotels the conversation was only considered for, not just the one it was attributed to.

Include hotels the conversation was only considered for, not just the one it was attributed to.

agent_idstring uuid nullable
outcome_agent_refstring nullable
outcome_agent_refsstring[] nullable
outcome_agent_refs_excludestring[] nullable
outcome_agent_kind'ai_voice' | 'ai_text' | 'human' nullable
reviewedboolean nullable
statusstring nullable
has_booking_intentboolean nullable
has_bookingboolean nullable
booking_madeboolean nullable
booking_attributedboolean nullable
tag_idsstring[] nullable
countrystring nullable
is_after_hoursboolean nullable
population_filtersstring[] nullable

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

searchstring nullable
standard_filtersstring nullable
metric_filtersstring nullable
sort_bystring nullable
sort_order'asc' | 'desc' nullable
strictboolean

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

voice_agent_idstring uuid nullable

Deprecated - use agent_id.

Deprecated - use agent_id.

metric_idstring uuid nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

metric_state'pass' | 'fail' | 'na' | 'not_run' | 'error' nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

booking_intentboolean nullable

Deprecated - use has_booking_intent.

Deprecated - use has_booking_intent.

Response

Successful Response

totalinteger required

Rows matching the filters, in total_units.

limitinteger required

Page size actually applied.

offsetinteger required

Rows skipped.

has_moreboolean required

Whether another page exists.

total_unit'logical_call' | 'row'

What total counts. row for text, email and bookings. voice returns logical_call, because a transferred call is several legs in items but one call in total — so a caller that counts items will legitimately disagree with total.

applied_filtersstring[]

Filters that were compiled into the query.

pageinteger nullable

Deprecated — derive from offset/limit.

per_pageinteger nullable

Deprecated — use limit.

Changes

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