Square icon

Square

Consume Square API

Booking → Get Many

AI-generated

Overview

This node operation retrieves multiple booking records from the Square API. It supports filtering bookings by customer ID, location ID, team member ID, and start time range. Users can choose to return all matching bookings or limit the number of results returned. This operation is useful for scenarios where you need to fetch a list of bookings for reporting, analysis, or integration with other systems.

Use Case Examples

  1. Fetch all bookings for a specific customer within a date range.
  2. Retrieve up to 50 bookings for a particular location.
  3. Get all bookings assigned to a specific team member.

Properties

Name Meaning
Return All Whether to return all booking results or only up to a given limit.
Limit Maximum number of booking results to return when not returning all.
Filters Filters to narrow down the bookings retrieved, including customer ID, location ID, start time range, and team member ID.

Output

JSON

  • booking_id - Unique identifier of the booking.
  • location_id - Identifier of the location associated with the booking.
  • team_member_id - Identifier of the team member associated with the booking.
  • customer_id - Identifier of the customer associated with the booking.
  • start_at - Start time of the booking.
  • end_at - End time of the booking.
  • status - Current status of the booking.

Dependencies

  • Square API with appropriate API key credentials

Troubleshooting

  • Common issues include invalid or missing API credentials, resulting in authentication errors.
  • Incorrect filter values may lead to empty results or API errors.
  • Exceeding rate limits of the Square API can cause request failures; implement retry logic or rate limiting.
  • If 'Return All' is false and 'Limit' is set too low, not all desired bookings may be retrieved.

Links

Discussion