# Booqable

Booqable is a rental software platform that helps businesses manage inventory, bookings, and online reservations.

- **Category:** scheduling & booking
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 49
- **Triggers:** 0
- **Slug:** `BOOQABLE`
- **Version:** 20260313_00

## Tools

### Create Customer

**Slug:** `BOOQABLE_CREATE_CUSTOMER`

Tool to create a new customer. Use when onboarding a new client and you have verified their details. Example: Create 'Jane Doe' with email jane@doe.com.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the customer |
| `email` | string | No | E-mail address of the customer |
| `phone` | string | No | Customer's phone number |
| `tax_region_id` | integer | No | Associated tax region ID |
| `properties_attributes` | array | No | List of custom properties for the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `BOOQABLE_CREATE_ORDER`

Tool to create a new order. Use after collecting valid customer ID and timing details. Example: Create an order for customer '297f2584-...' starting at '2018-01-01T09:00:00Z'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stops_at` | string | No | Order stop datetime in ISO8601 format, e.g., '2018-02-01T09:00:00Z'. |
| `starts_at` | string | No | Order start datetime in ISO8601 format, e.g., '2018-01-01T09:00:00Z'. |
| `customer_id` | string | Yes | ID of the customer for the order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Group

**Slug:** `BOOQABLE_CREATE_PRODUCT_GROUP`

Tool to create a new product group in Booqable. Use when you have defined the group's name and pricing details and want to organize items under a shared group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sku` | string | No | Stock Keeping Unit identifier for the product group. |
| `name` | string | Yes | Name of the product group. |
| `price_type` | string | No | Pricing type (e.g., 'simple'). |
| `price_period` | string | No | Pricing period (e.g., 'day'). |
| `base_price_in_cents` | integer | No | Base price in cents for the product group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `BOOQABLE_DELETE_CUSTOMER`

Tool to delete (archive) a customer by ID. Use after confirming the customer should be hidden from searches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (UUID or numeric ID) of the customer to delete (archive). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Order

**Slug:** `BOOQABLE_DELETE_ORDER`

Tool to delete (archive) an order by ID. Use when you need to hide completed or canceled orders from active listings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The UUID or numeric ID of the order to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product Group

**Slug:** `BOOQABLE_DELETE_PRODUCT_GROUP`

Tool to delete a product group by ID. Use when you need to permanently remove a product group from your catalog after confirming its identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the product group to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `BOOQABLE_GET_CUSTOMER`

Tool to fetch a specific customer by ID. Use after obtaining a customer identifier to retrieve full customer details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (UUID) or customer number to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customers

**Slug:** `BOOQABLE_GET_CUSTOMERS`

Tool to retrieve a list of customers. Use when you need to paginate through customers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `per` | integer | No | Number of customers per page. If None, server default is used. |
| `page` | integer | No | Page number to retrieve, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inventory Levels

**Slug:** `BOOQABLE_GET_INVENTORY_LEVELS`

Tool to fetch inventory levels for products. Shows availability of products across locations for a date range. Use when checking product availability or stock levels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter_from` | string | Yes | Start date for inventory level query in ISO 8601 format (YYYY-MM-DD). Required. |
| `filter_till` | string | Yes | End date for inventory level query in ISO 8601 format (YYYY-MM-DD). Required. |
| `filter_item_id` | string | No | UUID of the item (product) to check inventory levels for. Either item_id or order_id must be supplied. |
| `filter_order_id` | string | No | UUID of the order to check inventory levels for. Either item_id or order_id must be supplied. |
| `filter_location_id` | string | No | UUID of specific location to filter inventory levels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get New Order

**Slug:** `BOOQABLE_GET_NEW_ORDER`

Tool to retrieve a new order template with default values. Use when you need to initialize an order creation form or fetch default order settings before creating an order.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `BOOQABLE_GET_ORDER`

Tool to retrieve a specific order by ID. Use when you need complete details of a known order, including optional relationships like customer or coupon. Call after confirming the order ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (UUID or numeric) of the order to fetch. |
| `fields` | array | No | List of order fields to include in the response, e.g., ['created_at','updated_at','number']. |
| `include` | array | No | List of related resources to include, e.g., ['customer','coupon','start_location']. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product

**Slug:** `BOOQABLE_GET_PRODUCT`

Tool to fetch a specific product by ID. Use after obtaining a product identifier to retrieve detailed inventory item data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the product to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Product Group

**Slug:** `BOOQABLE_GET_PRODUCT_GROUP`

Tool to fetch a specific product group by ID. Use after obtaining the product group identifier to retrieve its full details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier (UUID) of the product group to fetch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Barcodes

**Slug:** `BOOQABLE_LIST_BARCODES`

Tool to retrieve a list of barcodes. Use when you need to list barcodes with pagination, filtering by owner, type, or dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by field(s). Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Specify which fields to return instead of defaults. |
| `include` | string | No | Sideload related resources (e.g., 'owner' to load the owner entity). |
| `filter_id` | string | No | Filter barcodes by ID. |
| `page_size` | integer | No | Number of barcodes per page. If None, server default (25) is used. |
| `meta_total` | string | No | Request count metadata (e.g., 'count' to get total count). |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_number` | string | No | Filter barcodes by barcode number. |
| `filter_owner_id` | string | No | Filter barcodes by owner ID. |
| `filter_created_at` | string | No | Filter barcodes by creation date (supports operators like [gt], [gte], [lt], [lte]). |
| `filter_owner_type` | string | No | Filter barcodes by owner type (e.g., 'customers', 'products'). |
| `filter_updated_at` | string | No | Filter barcodes by update date (supports operators like [gt], [gte], [lt], [lte]). |
| `filter_barcode_type` | string | No | Filter barcodes by barcode type (e.g., 'qr_code'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bundle Items

**Slug:** `BOOQABLE_LIST_BUNDLE_ITEMS`

Tool to retrieve a list of bundle items. Use when you need to see which products are included in bundles, with their quantities and discounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order using field names. Prefix with '-' for descending order. Example: 'position' or '-created_at' |
| `fields` | array | No | Specify which fields to include instead of defaults. Example: ['id', 'bundle_id', 'quantity'] |
| `include` | string | No | Load related resources (comma-separated). Available: bundle, product |
| `filter_id` | string | No | Filter by specific bundle item ID (UUID format). |
| `page_size` | integer | No | Number of items per page (e.g., 10, 25, 50). |
| `page_number` | integer | No | Pagination page number to retrieve, must be >= 1. |
| `filter_position` | integer | No | Filter bundle items by position in the bundle. |
| `filter_quantity` | integer | No | Filter bundle items by quantity. |
| `filter_bundle_id` | string | No | Filter bundle items by bundle ID (UUID format). |
| `filter_product_id` | string | No | Filter bundle items by product ID (UUID format). |
| `filter_discount_percentage` | number | No | Filter bundle items by discount percentage. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Clusters

**Slug:** `BOOQABLE_LIST_CLUSTERS`

Tool to retrieve a list of clusters from Booqable. Use when you need to list clusters with optional filtering, field selection, and pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Controls data ordering. Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Allows selection of specific attributes to include in the response instead of defaults. |
| `include` | string | No | Loads associated resources (sideloading). Comma-separated list of relationships. |
| `page_size` | integer | No | Sets the quantity of items per page. |
| `page_number` | integer | No | Specifies which page to retrieve, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Coupons

**Slug:** `BOOQABLE_LIST_COUPONS`

Tool to retrieve a list of coupons. Use when you need to list or search for discount coupons with pagination and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for the results. Use field name optionally prefixed with '-' for descending order (e.g., 'name' or '-created_at'). |
| `fields` | array | No | List of specific fields to include in the response instead of default fields. |
| `include` | string | No | Comma-separated list of relationships to sideload. |
| `filter_id` | string | No | Filter by coupon ID using exact match. |
| `page_size` | string | No | The number of items per page. |
| `filter_code` | string | No | Filter by coupon code. |
| `page_number` | string | No | The page number to request for pagination. |
| `filter_archived` | string | No | Filter by archived status. |
| `filter_created_at` | string | No | Filter by creation timestamp. |
| `filter_percentage` | string | No | Filter by percentage value. |
| `filter_updated_at` | string | No | Filter by last update timestamp. |
| `filter_archived_at` | string | No | Filter by archived timestamp. |
| `filter_discount_type` | string | No | Filter by discount type (percentage or fixed_amount). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Default Properties

**Slug:** `BOOQABLE_LIST_DEFAULT_PROPERTIES`

Tool to retrieve a list of default properties from Booqable. Use when you need to view custom property definitions with pagination, filtering, or sorting options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Metadata requests (e.g., meta[total][]=count for total count). |
| `sort` | string | No | Sort by attributes using format: field1,-field2 (minus prefix for descending). |
| `fields` | array | No | List of specific fields to include instead of defaults. |
| `include` | string | No | Comma-separated list of relationships to sideload. |
| `filter.id` | string | No | Filter by default property ID. |
| `page.size` | integer | No | Number of items per page for pagination. |
| `filter.name` | string | No | Filter by name of the default property. |
| `page.number` | integer | No | Page number for pagination, must be >= 1. |
| `filter.created_at` | string | No | Filter by created_at timestamp (use operators like [gt], [lt], [gte], [lte]). |
| `filter.updated_at` | string | No | Filter by updated_at timestamp (use operators like [gt], [lt], [gte], [lte]). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents

**Slug:** `BOOQABLE_LIST_DOCUMENTS`

Tool to retrieve a list of documents. Use when you need to fetch invoices, quotes, contracts, or packing slips with optional filtering and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query to filter documents. |
| `sort` | string | No | Sort order. Prefix with - for descending. Examples: created_at, -updated_at, number |
| `fields` | string | No | Comma-separated list of fields to include instead of defaults. |
| `include` | string | No | Comma-separated list of related resources to sideload. Options: order, lines, customer, company, tax_values |
| `page_size` | integer | No | Number of documents per page. If None, server default is used. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_status` | string | No | Filter by document status. |
| `filter_archived` | boolean | No | Filter documents by archived status. |
| `filter_order_id` | string | No | Filter documents by order ID. |
| `filter_document_type` | string | No | Filter by document type (e.g., quote, contract, invoice, packing_slip). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Templates

**Slug:** `BOOQABLE_LIST_EMAIL_TEMPLATES`

Tool to list email templates from Booqable. Use when you need to retrieve available email templates with optional filtering, pagination, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by attributes. Prefix with '-' for descending order. Example: 'name' or '-created_at' |
| `fields` | array | No | List of specific fields to include in the response instead of defaults. Example: ['name', 'subject'] |
| `include` | string | No | Comma-separated list of relationships to sideload with the templates. |
| `filter_id` | string | No | Filter by email template ID (uuid). |
| `page_size` | integer | No | Number of items per page. Must be >= 1. |
| `filter_name` | string | No | Filter by email template name (string). |
| `page_number` | integer | No | Page number for pagination. Must be >= 1. |
| `filter_created_at` | string | No | Filter by created_at datetime. Use operators like [eq], [gt], [lt]. Example: '2024-01-01' |
| `filter_updated_at` | string | No | Filter by updated_at datetime. Use operators like [eq], [gt], [lt]. Example: '2024-01-01' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employees

**Slug:** `BOOQABLE_LIST_EMPLOYEES`

Tool to retrieve a list of employees from Booqable. Use when you need to list employee accounts with pagination and filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order (e.g., 'name' for ascending, '-name' for descending). Comma-separated for multiple fields. |
| `fields` | array | No | Specify which employee fields to return. If not provided, all default fields are returned. |
| `include` | string | No | Sideload relationships. Use comma-separated values for multiple relationships. |
| `page_size` | integer | No | Number of employees per page. If None, server default is used. |
| `filter_name` | string | No | Filter employees by name. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_email` | string | No | Filter employees by email address. |
| `filter_active` | boolean | No | Filter employees by active status (true or false). |
| `filter_created_at` | string | No | Filter employees by creation date. Use operators like 'eq', 'gt', 'gte', 'lt', 'lte'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory Breakdowns

**Slug:** `BOOQABLE_LIST_INVENTORY_BREAKDOWNS`

Tool to retrieve a list of inventory breakdowns filtered by status and product/product group. Use when you need to analyze inventory allocation across locations. Note: Both status filter and either product_id or product_group_id filter are required.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by field. Prefix with '-' for descending order. |
| `fields` | array | No | Specify which fields to return in the response. |
| `include` | string | No | Comma-separated list of related resources to include. Available: product, location, inventory_levels. |
| `page_size` | integer | No | Number of items per page, must be >= 1. |
| `page_number` | integer | No | Page number for pagination, must be >= 1. |
| `filter_status` | string ("expected" | "in_stock" | "archived") | Yes | Status of inventory breakdowns to retrieve. This is a required filter. |
| `filter_product_id` | string | No | Filter by specific product ID. Either product_id or product_group_id must be specified. |
| `filter_product_group_id` | string | No | Filter by product group ID. Either product_id or product_group_id must be specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items

**Slug:** `BOOQABLE_LIST_ITEMS`

Tool to retrieve a list of items (products and product groups). Use when you need to browse the catalog with pagination and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order using field names. Prefix with '-' for descending order. Example: 'name' or '-created_at' |
| `fields` | array | No | Specify which fields to include instead of defaults. Example: ['id', 'name', 'slug'] |
| `include` | string | No | Load related resources (comma-separated). Example: 'photos,properties' |
| `page_size` | string | No | Number of items per page (e.g., '10', '25', '50'). |
| `filter_name` | string | No | Filter items by name. |
| `filter_slug` | string | No | Filter items by slug. |
| `page_number` | string | No | Pagination page number to retrieve. |
| `filter_archived` | boolean | No | Filter items by archived status. |
| `filter_product_type` | string | No | Filter items by product type (e.g., 'rental', 'sales_item'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lines

**Slug:** `BOOQABLE_LIST_LINES`

Tool to retrieve a paginated list of lines from orders. Use when you need to list line items, with support for filtering by order, product, or other attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by attributes. Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Specify which fields to include instead of defaults. |
| `include` | string | No | Sideload related resources (comma-separated). Supported: order, product, tax_category. |
| `filter_id` | string | No | Filter lines by ID. |
| `page_size` | integer | No | Number of items per page for pagination. |
| `page_number` | integer | No | Page number for pagination. Must be >= 1. |
| `filter_title` | string | No | Filter lines by title. |
| `filter_taxable` | boolean | No | Filter lines by taxable status. |
| `filter_archived` | boolean | No | Filter lines by archived status. |
| `filter_order_id` | string | No | Filter lines by order ID. |
| `filter_quantity` | integer | No | Filter lines by quantity. |
| `filter_created_at` | string | No | Filter lines by creation date. Use ISO 8601 format or comparison operators. |
| `filter_product_id` | string | No | Filter lines by product ID. |
| `filter_updated_at` | string | No | Filter lines by last update date. Use ISO 8601 format or comparison operators. |
| `filter_discountable` | boolean | No | Filter lines by discountable status. |
| `filter_tax_category_id` | string | No | Filter lines by tax category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `BOOQABLE_LIST_LOCATIONS`

Tool to retrieve a list of locations from Booqable. Use when you need to view available locations with pagination, filtering, or sorting options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Metadata requests (e.g., total[]=count for total count). |
| `sort` | string | No | Sort by attributes using format: field1,-field2 (minus prefix for descending). |
| `fields` | array | No | List of specific fields to include instead of defaults. |
| `include` | string | No | Comma-separated list of relationships to sideload (e.g., photo). |
| `filter.id` | string | No | Filter by location ID. |
| `page.size` | integer | No | Number of items per page for pagination. |
| `filter.name` | string | No | Filter by location name. |
| `filter.slug` | string | No | Filter by location slug. |
| `page.number` | integer | No | Page number for pagination, must be >= 1. |
| `filter.archived` | boolean | No | Filter by archived status. |
| `filter.created_at` | string | No | Filter by created_at timestamp (use operators like [gt], [lt], [gte], [lte]). |
| `filter.updated_at` | string | No | Filter by updated_at timestamp (use operators like [gt], [lt], [gte], [lte]). |
| `filter.archived_at` | string | No | Filter by archived_at timestamp (use operators like [gt], [lt], [gte], [lte]). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notes

**Slug:** `BOOQABLE_LIST_NOTES`

Tool to retrieve a list of notes. Use when you need to list notes with optional filtering by owner, date, or content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | How to sort the data. Format: 'attribute1,-attribute2' where '-' prefix means descending order. |
| `fields` | array | No | List of fields to include instead of default fields. Examples: 'id', 'body', 'owner_id', 'owner_type', 'created_at', 'updated_at'. |
| `include` | string | No | Comma-separated list of relationships to include. Acceptable: 'owner'. |
| `filter_id` | string | No | Filter notes by ID. Supports exact match or operators. |
| `page_size` | integer | No | Number of notes per page. |
| `filter_text` | string | No | Filter notes by text content (searches in body field). |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_owner_id` | string | No | Filter notes by owner ID (the resource this note is attached to). |
| `filter_created_at` | string | No | Filter notes by creation date. Use operators like 'gt', 'gte', 'lt', 'lte' with ISO8601 timestamps. |
| `filter_owner_type` | string | No | Filter notes by owner type (e.g., 'customers', 'orders'). |
| `filter_updated_at` | string | No | Filter notes by last update date. Use operators like 'gt', 'gte', 'lt', 'lte' with ISO8601 timestamps. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Orders

**Slug:** `BOOQABLE_LIST_ORDERS`

Tool to retrieve a paginated list of orders. Use when you need to browse orders with support for filtering by status, customer, dates, and other attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by attributes. Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Specify which fields to include instead of defaults. Example: ['id', 'number', 'status'] |
| `include` | string | No | Sideload related resources (comma-separated). Supported: customer, coupon, start_location. |
| `page_size` | string | No | Number of items per page for pagination. |
| `page_number` | string | No | Page number for pagination. |
| `filter_number` | integer | No | Filter orders by order number. |
| `filter_status` | string | No | Filter orders by order status (e.g., reserved, confirmed). |
| `filter_archived` | boolean | No | Filter orders by archived status. |
| `filter_stops_at` | string | No | Filter orders by rental end date. Use ISO 8601 format or comparison operators. |
| `filter_starts_at` | string | No | Filter orders by rental start date. Use ISO 8601 format or comparison operators. |
| `filter_created_at` | string | No | Filter orders by creation date. Use ISO 8601 format or comparison operators. |
| `filter_updated_at` | string | No | Filter orders by last update date. Use ISO 8601 format or comparison operators. |
| `filter_customer_id` | string | No | Filter orders by customer ID. |
| `filter_tax_region_id` | string | No | Filter orders by tax region ID. |
| `filter_payment_status` | string | No | Filter orders by payment status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Methods

**Slug:** `BOOQABLE_LIST_PAYMENT_METHODS`

Tool to retrieve a list of payment methods from Booqable. Use when you need to list payment methods with optional filtering by creation date, customer, status, or ID, and support for pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Sends metadata with the request as a JSON object. |
| `sort` | string | No | Controls data ordering. Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Allows selection of specific attributes to include in the response. |
| `include` | string | No | Loads associated resources (sideloading). Comma-separated list of relationships. |
| `page_size` | integer | No | Sets the quantity of items per page. |
| `page_number` | integer | No | Specifies which page to retrieve, must be >= 1. |
| `filter_id_eq` | string | No | Filter by payment method ID (equal). Format: UUID. |
| `filter_id_not_eq` | string | No | Filter by payment method ID (not equal). Format: UUID. |
| `filter_status_eq` | string | No | Filter by status (equal). Possible values depend on the API specification. |
| `filter_created_at_eq` | string | No | Filter by creation date (equal). Format: ISO 8601 datetime. |
| `filter_created_at_gt` | string | No | Filter by creation date (greater than). Format: ISO 8601 datetime. |
| `filter_created_at_lt` | string | No | Filter by creation date (less than). Format: ISO 8601 datetime. |
| `filter_created_at_gte` | string | No | Filter by creation date (greater than or equal). Format: ISO 8601 datetime. |
| `filter_created_at_lte` | string | No | Filter by creation date (less than or equal). Format: ISO 8601 datetime. |
| `filter_customer_id_eq` | string | No | Filter by customer ID (equal). Format: UUID. |
| `filter_customer_id_not_eq` | string | No | Filter by customer ID (not equal). Format: UUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `BOOQABLE_LIST_PAYMENTS`

Tool to list all payments from Booqable. Use when you need to retrieve payment records with optional filtering by created_at, order_id, payment_method, or payment_status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Request metadata like aggregation counts. Use format: meta[total][]=count |
| `sort` | string | No | Sort by fields. Use - prefix for descending order (e.g., -created_at). |
| `fields` | array | No | Specify which fields to return instead of defaults. Provide as a list of field names. |
| `include` | string | No | Sideload related resources (comma-separated list of relationships). |
| `filter_id` | string | No | Filter by payment ID (uuid). |
| `page_size` | string | No | Items per page for pagination. |
| `page_number` | string | No | Page number for pagination. |
| `filter_order_id` | string | No | Filter by order ID (uuid). |
| `filter_created_at` | string | No | Filter by created_at datetime. Use operators like filter[created_at][gte]=2024-01-01. |
| `filter_payment_method` | string | No | Filter by payment method. |
| `filter_payment_status` | string | No | Filter by payment status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Photos

**Slug:** `BOOQABLE_LIST_PHOTOS`

Tool to retrieve a paginated list of photos from Booqable. Use when you need to list photos with support for filtering by owner resource and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by attributes. Prefix with '-' for descending order (e.g., '-created_at'). |
| `fields` | array | No | Specify which fields to include instead of defaults. Example: ['id', 'filename', 'alt_text'] |
| `include` | string | No | Sideload related resources (comma-separated). Example: 'owner' |
| `page_size` | integer | No | Number of items per page for pagination. |
| `page_number` | integer | No | Page number for pagination. Must be >= 1. |
| `filter_owner_id` | string | No | Filter photos by owner ID (UUID format). |
| `filter_owner_type` | string | No | Filter photos by owner type (e.g., 'products', 'product_groups'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Plannings

**Slug:** `BOOQABLE_LIST_PLANNINGS`

Tool to retrieve planning records that track product and bundle reservations across locations and time periods. Use when you need to check what items are planned or reserved for specific dates, locations, or orders.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order (e.g., 'starts_at' for ascending, '-starts_at' for descending). |
| `fields` | array | No | List of specific fields to include in the response instead of defaults. |
| `include` | string | No | Comma-separated list of relationships to include (e.g., 'product', 'bundle', 'location', 'order'). |
| `page_size` | integer | No | Number of plannings per page. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_item_id` | string | No | Filter plannings by item ID (products or bundles). |
| `filter_order_id` | string | No | Filter plannings by order ID. |
| `filter_reserved_from_gte` | string | No | Filter plannings with reserved_from at or after this date-time (ISO 8601 format). |
| `filter_reserved_till_lte` | string | No | Filter plannings with reserved_till at or before this date-time (ISO 8601 format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Price Rulesets

**Slug:** `BOOQABLE_LIST_PRICE_RULESETS`

Tool to list price rulesets. Use when you need to retrieve price rulesets with optional filtering by archived status, name, or ID, and pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort criteria. Prefix with - for descending. Example: name or -created_at |
| `fields` | array | No | Comma-separated fields to return instead of defaults. Example: id,name |
| `include` | string | No | Comma-separated relationships to sideload. Available: price_rules |
| `filter_id` | string | No | Filter by price ruleset ID (UUID). Supports eq, not_eq operators. |
| `page_size` | integer | No | Number of items per page. |
| `filter_name` | string | No | Filter by name. Supports eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match operators. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_archived` | boolean | No | Filter by archived status. True returns only archived rulesets, false returns non-archived. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Price Structures

**Slug:** `BOOQABLE_LIST_PRICE_STRUCTURES`

Tool to list price structures. Use when you need to retrieve price structures with optional filtering by name, ID, or product group, and pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort criteria. Prefix with - for descending. Example: name or -created_at |
| `fields` | array | No | Comma-separated fields to return instead of defaults. Example: id,name,created_at |
| `include` | string | No | Comma-separated relationships to sideload. Available: price_tiles |
| `filter_id` | string | No | Filter by price structure ID (UUID). Supports eq, not_eq operators. |
| `page_size` | integer | No | Number of items per page. |
| `filter_name` | string | No | Filter by name. Supports eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match operators. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_product_group_id` | string | No | Filter by product group ID (UUID). Supports eq, not_eq operators. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Groups

**Slug:** `BOOQABLE_LIST_PRODUCT_GROUPS`

Tool to list product groups from Booqable API v4. Use when you need to retrieve multiple product groups with filtering, pagination, and field selection options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Field to sort by. Prefix with '-' for descending order (e.g., '-created_at' for newest first). |
| `fields` | array | No | List of fields to include in the response (e.g., ['id', 'name', 'slug']). If not specified, all fields are returned. |
| `filter` | string | No | Filter criteria to apply. Use syntax like 'archived:false' or 'product_type:rental'. |
| `include` | string | No | Comma-separated list of relationships to include (e.g., 'photo,tax_category'). |
| `page_size` | string | No | Number of items per page. If not specified, server default is used. |
| `page_number` | string | No | Page number to retrieve. Defaults to 1 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products

**Slug:** `BOOQABLE_LIST_PRODUCTS`

Tool to retrieve a list of products. Use when you need to browse products with pagination and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order using field names. Prefix with '-' for descending order. Example: 'name' or '-created_at' |
| `fields` | array | No | Specify which fields to include instead of defaults. Example: ['id', 'name', 'slug'] |
| `include` | string | No | Load related resources (comma-separated). Available: 'photos', 'inventory_levels', 'tax_category', 'product_group'. Example: 'photos,product_group' |
| `page_size` | string | No | Number of products per page (e.g., '10', '25', '50'). |
| `filter_name` | string | No | Filter products by name. |
| `page_number` | string | No | Pagination page number to retrieve. |
| `filter_taxable` | boolean | No | Filter products by taxable status. |
| `filter_archived` | boolean | No | Filter products by archived status. |
| `filter_tag_list` | string | No | Filter products by tag. |
| `filter_discountable` | boolean | No | Filter products by discountable status. |
| `filter_product_group_id` | string | No | Filter products by product group ID (UUID). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Properties

**Slug:** `BOOQABLE_LIST_PROPERTIES`

Tool to retrieve a list of properties. Use when you need to list custom properties associated with customers, products, or other resources in Booqable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Request metadata like aggregations. Use syntax like 'total[]=count'. |
| `sort` | string | No | Sort order. Prefix with '-' for descending. Examples: 'name', '-created_at', 'property_type'. |
| `fields` | array | No | Specify which fields to return instead of defaults. Use field names like 'name', 'value', 'property_type'. |
| `filter` | string | No | Apply filters using syntax like 'name eq value' or 'owner_id eq uuid'. Supports operators: eq, neq, gt, gte, lt, lte. |
| `include` | string | No | Sideload related resources (comma-separated). Available: owner, default_property. |
| `page_size` | integer | No | Number of items per page, must be >= 1. |
| `page_number` | integer | No | Page number for pagination, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Provinces

**Slug:** `BOOQABLE_LIST_PROVINCES`

Tool to retrieve a list of provinces. Use when you need to list available provinces, optionally filtered by country.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for provinces. Use field name for ascending, prefix with minus for descending (e.g., 'name' or '-name'). |
| `filter` | object | No | Filter conditions to apply. Supports filtering by country_id, name, created_at, updated_at, id. |
| `page_size` | integer | No | Number of provinces per page. If None, server default is used. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stock Item Plannings

**Slug:** `BOOQABLE_LIST_STOCK_ITEM_PLANNINGS`

Tool to retrieve a list of stock item plannings. Use when you need to list stock item plannings with filtering and pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | string | No | Include metadata like total count. Use 'total_count' to include count. |
| `sort` | string | No | Sort criteria using format attribute1,-attribute2. Prefix with '-' for descending order. |
| `fields` | array | No | Comma-separated fields to return in the response. |
| `include` | string | No | Comma-separated list of related resources to sideload (e.g., 'stock_item,planning'). |
| `filter_id` | string | No | Filter by id with operators: eq, not_eq. Format: operator:value. |
| `page_size` | integer | No | Number of stock item plannings per page. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_archived` | boolean | No | Filter by archived status (true or false). |
| `filter_created_at` | string | No | Filter by created_at with operators: eq, not_eq, gt, gte, lt, lte. Format: operator:value (e.g., 'gte:2024-01-01'). |
| `filter_planning_id` | string | No | Filter by planning_id with operators: eq, not_eq. Format: operator:value. |
| `filter_stock_item_id` | string | No | Filter by stock_item_id with operators: eq, not_eq. Format: operator:value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Stock Items

**Slug:** `BOOQABLE_LIST_STOCK_ITEMS`

Tool to retrieve a list of stock items. Use when you need to list physical inventory items with tracking identifiers like serial numbers or barcodes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for the results (e.g., 'created_at' for ascending, '-created_at' for descending). |
| `fields` | string | No | Comma-separated list of fields to include in the response (e.g., 'id,barcode,status'). |
| `filter` | string | No | Filter criteria in the format 'field[operator]=value' (e.g., 'status[eq]=available'). Filterable fields: archived, archived_at, created_at, id, location_id, product_id, status, stock_item_type, updated_at. |
| `include` | string | No | Comma-separated list of related resources to include (sideload) in the response. |
| `page_size` | string | No | Number of stock items per page. Used to control pagination size. |
| `page_number` | string | No | The page number to retrieve. Used for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tax Rates

**Slug:** `BOOQABLE_LIST_TAX_RATES`

Tool to retrieve a list of tax rates. Use when you need to list or search for tax rates with pagination and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order for the results. Use field name optionally prefixed with '-' for descending order (e.g., 'name' or '-created_at'). |
| `fields` | array | No | List of specific fields to include in the response instead of default fields. |
| `include` | string | No | Comma-separated list of relationships to sideload (e.g., 'tax_category,region'). |
| `filter_id` | string | No | Filter by tax rate ID using exact match. |
| `page_size` | string | No | The number of items per page. |
| `filter_name` | string | No | Filter by tax rate name. |
| `page_number` | string | No | The page number to request for pagination. |
| `filter_region_id` | string | No | Filter by region ID. |
| `filter_percentage` | string | No | Filter by percentage value. |
| `filter_tax_category_id` | string | No | Filter by tax category ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tax Values

**Slug:** `BOOQABLE_LIST_TAX_VALUES`

Tool to retrieve a list of tax values. Use when you need to fetch tax rates with optional filtering, pagination, and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort results by attributes. Use '-' prefix for descending order (e.g., 'created_at' or '-percentage'). |
| `include` | string | No | Comma-separated list of relationships to include (e.g., 'tax_category'). |
| `filter_eq` | object | No | Filter by exact match. Provide field name and value (e.g., {'tax_category_id': 'uuid'}). |
| `page_size` | integer | No | Number of tax values per page. |
| `page_number` | integer | No | Page number to retrieve for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `BOOQABLE_LIST_USERS`

Tool to retrieve a list of users from Booqable. Use when you need to list user accounts with pagination and filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort order (e.g., 'name' for ascending, '-name' for descending). Comma-separated for multiple fields. |
| `fields` | array | No | Specify which user fields to return. If not provided, all default fields are returned. |
| `include` | string | No | Sideload relationships (e.g., 'company'). Use comma-separated values for multiple relationships. |
| `page_size` | integer | No | Number of users per page. If None, server default is used. |
| `filter_name` | string | No | Filter users by name. |
| `page_number` | integer | No | Page number to retrieve, must be >= 1. |
| `filter_email` | string | No | Filter users by email address. |
| `filter_disabled` | boolean | No | Filter users by disabled status (true or false). |
| `filter_created_at` | string | No | Filter users by creation date. Use operators like 'eq', 'gt', 'gte', 'lt', 'lte'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Bundles

**Slug:** `BOOQABLE_SEARCH_BUNDLES`

Tool to search bundles with advanced filtering. Use when you need to find bundles by specific criteria (discountable, taxable, show_in_store, etc.) using complex queries with logical operators.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Fields specification for bundle resources. |
| `filter` | object | No | Filter structure for searching bundles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Customers

**Slug:** `BOOQABLE_SEARCH_CUSTOMERS`

Tool to search customers in the Booqable system. Use when you need to retrieve customer data with optional field selection and relationship inclusion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Comma-separated list of relationships to include (e.g., 'orders,notes'). |
| `fields_customers` | string | No | Comma-separated list of customer fields to return (e.g., 'id,name,email'). If not specified, all fields are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Documents

**Slug:** `BOOQABLE_SEARCH_DOCUMENTS`

Tool to search documents using advanced filtering with logical operators. Use when you need to find documents matching complex criteria with AND/OR conditions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Object specifying which fields to return for documents. |
| `filter` | object | No | Filter conditions as field-operator-value pairs (e.g., {'status': {'eq': 'confirmed'}, 'archived': {'eq': false}}). Multiple fields act as implicit AND. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Items

**Slug:** `BOOQABLE_SEARCH_ITEMS`

Tool to search items (products and bundles) with advanced filtering. Use when you need to find items by specific criteria (name, product_type, archived status, etc.) using complex queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Comma-separated list of relationships to include (e.g., 'photo,tax_category'). |
| `fields_items` | string | No | Comma-separated list of item fields to return (e.g., 'id,name,product_type,sku'). If not specified, all fields are returned. |
| `filter_conditions` | object | No | Filter conditions with logical operator. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Orders

**Slug:** `BOOQABLE_SEARCH_ORDERS`

Tool to search orders with advanced filtering using logical operators. Use when you need to find orders by specific criteria (status, dates, customer) with complex queries like date ranges or multiple conditions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | string | No | Comma-separated list of relationships to sideload (e.g., 'customer,lines,plannings'). |
| `fields_orders` | string | No | Comma-separated list of order fields to return (e.g., 'id,number,status,customer_id'). If not specified, all fields are returned. |
| `filter_conditions` | object | No | Filter conditions with logical operator for order search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Plannings

**Slug:** `BOOQABLE_SEARCH_PLANNINGS`

Tool to search plannings with advanced filtering. Use when you need to find planning records by specific criteria using complex queries with logical operators.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | object | No | Field selection specification for controlling response fields. |
| `include` | string | No | Comma-separated list of relationships to include (e.g., 'product', 'bundle', 'location', 'order'). |
| `filter_conditions` | object | No | Filter conditions with logical operator for advanced search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Company

**Slug:** `BOOQABLE_UPDATE_COMPANIES`

Tool to update the current company's information in Booqable. Use when you need to modify company details such as name, contact information, address, or billing settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | City name |
| `name` | string | No | Company name |
| `email` | string | No | Company email address |
| `phone` | string | No | Company phone number |
| `region` | string | No | State or region |
| `country` | string | No | Country name |
| `website` | string | No | Company website URL |
| `zipcode` | string | No | Postal/ZIP code |
| `timezone` | string | No | Company timezone (e.g., 'America/New_York', 'Europe/Amsterdam') |
| `vat_number` | string | No | VAT or tax identification number |
| `billing_email` | string | No | Billing email address (if different from main email) |
| `address_line_1` | string | No | First line of the company address |
| `address_line_2` | string | No | Second line of the company address (optional) |
| `use_billing_address` | boolean | No | Whether to use a separate billing address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |