POST /v2/bookings/availability/search

Searches for availabilities for booking.

Servers

https://connect.squareup.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`query`	Object	Yes	Query conditions to search for availabilities of bookings.
`query.filter`	Object	Yes	A query filter to search for availabilities by.
`query.filter.location_id`	String	No	The query expression to search for availabilities matching the specified seller location IDs. This query expression is not applicable when `booking_id` is present.
`query.filter.booking_id`	String	No	The query expression to search for availabilities for an existing booking by matching the specified `booking_id` value. This is commonly used to reschedule an appointment. If this expression is specified, the `location_id` and `segment_filters` expressions are not allowed.
`query.filter.start_at_range`	Object	Yes	Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.
`query.filter.start_at_range.start_at`	String	No	A datetime value in RFC 3339 format indicating when the time range starts.
`query.filter.start_at_range.end_at`	String	No	A datetime value in RFC 3339 format indicating when the time range ends.
`query.filter.segment_filters[]`	Array	No	The list of segment filters to apply. A query with `n` segment filters returns availabilities with `n` segments per availability. It is not applicable when `booking_id` is present.
`query.filter.segment_filters[].service_variation_id`	String	Yes	The ID of the CatalogItemVariation representing the service booked in this segment.
`query.filter.segment_filters[].team_member_id_filter`	Object	No	A filter to select resources based on an exact field value. For any given value, the value can only be in one property. Depending on the field, either all properties can be set or only a subset will be available. Refer to the documentation of the field.
`query.filter.segment_filters[].team_member_id_filter.any[]`	Array	No	A list of terms where at least one of them must be present on the field of the resource.
`query.filter.segment_filters[].team_member_id_filter.all[]`	Array	No	A list of terms that must be present on the field of the resource.
`query.filter.segment_filters[].team_member_id_filter.none[]`	Array	No	A list of terms that must not be present on the field the resource

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.