AnnyInstall

Summary

Retrieve multiple bookings with optional filtering, pagination, sorting, and inclusion of related entities from the Anny booking platform.

Inputs

• Authentication (required) — Choose the authentication method to access the API: OAuth2 or Access Token.
• Simplify — Return a simplified version of the response instead of the raw data; defaults to true.
• Page Size — Number of bookings to retrieve per page, with a maximum of 30; defaults to 30.
• Page Number — The page number of results to retrieve; defaults to 1.
• Include — Comma-separated related entities to include with each booking, e.g., customer, resource, service.
• Search — Search filter string to match bookings by various fields.
• Custom Filters — Custom key-value filters to refine the booking results, e.g., filter[status]=active.
• Sort — Sort bookings by created date or start date in ascending or descending order.

Output shape

a list of booking records

Returns an array of booking objects matching the query parameters. The response can be simplified if 'Simplify' is true, otherwise returns raw API data. Pagination is controlled via 'Page Size' and 'Page Number'. Related entities can be included with the 'Include' parameter.

Examples

Example 1: Retrieve the first 10 bookings including related customer and service data, sorted by newest created date.

Set Page Size to 10, Include to "customer,service", and Sort to "-created_at". Authentication must be configured.