• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
SegmentFilter BETA

A query filter to search for appointment segments by.

Properties

Name Description
service_variation_id
string

Required

The ID of the CatalogItemVariation representing the service booked in this segment.

Min Length 1
team_member_id_filter
FilterValue

A query expression specifying which team members satisfy the condition. Supported expressions are

  • ANY: include team members whose IDs match any member of the specified list.
  • NONE: exclude team members whose IDs match members of the specified list.

The ALL expression is not supported in the Bookings API. When no expression is specified, any service-providing team member is eligible to fulfill the Booking.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?