Square

Consume Square API

Actions21

Overview

The node integrates with the Square API to retrieve team member profiles related to bookings. Specifically, the "Get Team Member Profiles" operation fetches profiles of team members who can be associated with booking services. This operation supports filtering by whether the team members are bookable and by location ID.

This node is useful in scenarios where you want to manage or display information about staff or service providers available for bookings within a specific location or only those currently available for booking. For example, a business could use this node to dynamically populate a scheduling interface with available team members based on location and availability status.

Properties

Name	Meaning
Bookable Only	Boolean flag indicating whether to return only team members who are bookable (true/false)
Location ID	String to filter team member profiles by a specific location ID

Output

The output is a JSON array containing team member profile objects as returned by the Square API endpoint /bookings/team-member-booking-profiles. Each object typically includes details such as team member identifiers, names, contact info, and booking-related attributes.

No binary data output is produced by this operation.

Dependencies

Requires an API key credential for authenticating with the Square API.
The node uses the Square API base URL, which switches between sandbox and production environments based on the configured environment credential.
No additional external dependencies beyond the Square API and n8n's HTTP request capabilities.

Troubleshooting

Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Providing an invalid locationId may result in empty results or errors.
- Network connectivity issues can prevent successful API calls.
Error messages:
- Errors from the Square API will be propagated, such as authorization errors or invalid parameters.
- If the node is set to continue on failure, error messages will be included in the output JSON under an error field.
Resolutions:
- Verify that the API key credential is correctly configured and has appropriate permissions.
- Ensure the locationId used exists and is valid within your Square account.
- Check network connectivity and firewall settings if requests fail.