Booqable is a rental software platform that helps businesses manage inventory, bookings, and online reservations.
Booqable is a rental software platform that helps businesses manage inventory, bookings, and online reservations. On Nagent, Booqable is exposed as a fully-configurable scheduling & booking integration that any agent can call — 49 actions, and API key authentication. No code is required to wire Booqable into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Booqable to automate the kinds of tasks scheduling & booking teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Booqable into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Booqable, with input parameters and output schema. Drop these into any step of an agent built in Helix.
BOOQABLE_CREATE_CUSTOMERTool 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
The name of the customer
E-mail address of the customer
Customer's phone number
Associated tax region ID
List of custom properties for the customer
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_CREATE_ORDERTool 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
Order stop datetime in ISO8601 format, e.g., '2018-02-01T09:00:00Z'.
Order start datetime in ISO8601 format, e.g., '2018-01-01T09:00:00Z'.
ID of the customer for the order.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_CREATE_PRODUCT_GROUPTool 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
Stock Keeping Unit identifier for the product group.
Name of the product group.
Pricing type (e.g., 'simple').
Pricing period (e.g., 'day').
Base price in cents for the product group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_DELETE_CUSTOMERTool to delete (archive) a customer by ID. Use after confirming the customer should be hidden from searches.
Input parameters
The unique identifier (UUID or numeric ID) of the customer to delete (archive).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_DELETE_ORDERTool to delete (archive) an order by ID. Use when you need to hide completed or canceled orders from active listings.
Input parameters
The UUID or numeric ID of the order to archive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_DELETE_PRODUCT_GROUPTool 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
The unique identifier of the product group to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_CUSTOMERTool to fetch a specific customer by ID. Use after obtaining a customer identifier to retrieve full customer details.
Input parameters
Unique identifier (UUID) or customer number to fetch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_CUSTOMERSTool to retrieve a list of customers. Use when you need to paginate through customers.
Input parameters
Number of customers per page. If None, server default is used.
Page number to retrieve, must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_INVENTORY_LEVELSTool 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
Number of items per page for pagination.
Start date for inventory level query in ISO 8601 format (YYYY-MM-DD). Required.
End date for inventory level query in ISO 8601 format (YYYY-MM-DD). Required.
Page number for pagination.
UUID of the item (product) to check inventory levels for. Either item_id or order_id must be supplied.
UUID of the order to check inventory levels for. Either item_id or order_id must be supplied.
UUID of specific location to filter inventory levels.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_NEW_ORDERTool 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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_ORDERTool 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
Unique identifier (UUID or numeric) of the order to fetch.
List of order fields to include in the response, e.g., \['created_at','updated_at','number'\].
List of related resources to include, e.g., \['customer','coupon','start_location'\].
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_PRODUCTTool to fetch a specific product by ID. Use after obtaining a product identifier to retrieve detailed inventory item data.
Input parameters
Unique identifier of the product to fetch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_GET_PRODUCT_GROUPTool to fetch a specific product group by ID. Use after obtaining the product group identifier to retrieve its full details.
Input parameters
Unique identifier (UUID) of the product group to fetch.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_BARCODESTool to retrieve a list of barcodes. Use when you need to list barcodes with pagination, filtering by owner, type, or dates.
Input parameters
Sort results by field(s). Prefix with '-' for descending order (e.g., '-created_at').
Specify which fields to return instead of defaults.
Sideload related resources (e.g., 'owner' to load the owner entity).
Filter barcodes by ID.
Number of barcodes per page. If None, server default (25) is used.
Request count metadata (e.g., 'count' to get total count).
Page number to retrieve, must be >= 1.
Filter barcodes by barcode number.
Filter barcodes by owner ID.
Filter barcodes by creation date (supports operators like \[gt\], \[gte\], \[lt\], \[lte\]).
Filter barcodes by owner type (e.g., 'customers', 'products').
Filter barcodes by update date (supports operators like \[gt\], \[gte\], \[lt\], \[lte\]).
Filter barcodes by barcode type (e.g., 'qr_code').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_BUNDLE_ITEMSTool 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
Sort order using field names. Prefix with '-' for descending order. Example: 'position' or '-created_at'
Specify which fields to include instead of defaults. Example: \['id', 'bundle_id', 'quantity'\]
Load related resources (comma-separated). Available: bundle, product
Filter by specific bundle item ID (UUID format).
Number of items per page (e.g., 10, 25, 50).
Pagination page number to retrieve, must be >= 1.
Filter bundle items by position in the bundle.
Filter bundle items by quantity.
Filter bundle items by bundle ID (UUID format).
Filter bundle items by product ID (UUID format).
Filter bundle items by discount percentage.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_CLUSTERSTool 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
Controls data ordering. Prefix with '-' for descending order (e.g., '-created_at').
Allows selection of specific attributes to include in the response instead of defaults.
Loads associated resources (sideloading). Comma-separated list of relationships.
Sets the quantity of items per page.
Specifies which page to retrieve, must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_COUPONSTool to retrieve a list of coupons. Use when you need to list or search for discount coupons with pagination and filtering.
Input parameters
Sort order for the results. Use field name optionally prefixed with '-' for descending order (e.g., 'name' or '-created_at').
List of specific fields to include in the response instead of default fields.
Comma-separated list of relationships to sideload.
Filter by coupon ID using exact match.
The number of items per page.
Filter by coupon code.
The page number to request for pagination.
Filter by archived status.
Filter by creation timestamp.
Filter by percentage value.
Filter by last update timestamp.
Filter by archived timestamp.
Filter by discount type (percentage or fixed_amount).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_DEFAULT_PROPERTIESTool 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
Metadata requests (e.g., meta\[total\]\[\]=count for total count).
Sort by attributes using format: field1,-field2 (minus prefix for descending).
List of specific fields to include instead of defaults.
Comma-separated list of relationships to sideload.
Filter by default property ID.
Number of items per page for pagination.
Filter by name of the default property.
Page number for pagination, must be >= 1.
Filter by created_at timestamp (use operators like \[gt\], \[lt\], \[gte\], \[lte\]).
Filter by updated_at timestamp (use operators like \[gt\], \[lt\], \[gte\], \[lte\]).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_DOCUMENTSTool 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
Search query to filter documents.
Sort order. Prefix with - for descending. Examples: created_at, -updated_at, number
Comma-separated list of fields to include instead of defaults.
Comma-separated list of related resources to sideload. Options: order, lines, customer, company, tax_values
Number of documents per page. If None, server default is used.
Page number to retrieve, must be >= 1.
Filter by document status.
Filter documents by archived status.
Filter documents by order ID.
Filter by document type (e.g., quote, contract, invoice, packing_slip).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_EMAIL_TEMPLATESTool to list email templates from Booqable. Use when you need to retrieve available email templates with optional filtering, pagination, and sorting.
Input parameters
Sort results by attributes. Prefix with '-' for descending order. Example: 'name' or '-created_at'
List of specific fields to include in the response instead of defaults. Example: \['name', 'subject'\]
Comma-separated list of relationships to sideload with the templates.
Filter by email template ID (uuid).
Number of items per page. Must be >= 1.
Filter by email template name (string).
Page number for pagination. Must be >= 1.
Filter by created_at datetime. Use operators like \[eq\], \[gt\], \[lt\]. Example: '2024-01-01'
Filter by updated_at datetime. Use operators like \[eq\], \[gt\], \[lt\]. Example: '2024-01-01'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_EMPLOYEESTool to retrieve a list of employees from Booqable. Use when you need to list employee accounts with pagination and filtering options.
Input parameters
Sort order (e.g., 'name' for ascending, '-name' for descending). Comma-separated for multiple fields.
Specify which employee fields to return. If not provided, all default fields are returned.
Sideload relationships. Use comma-separated values for multiple relationships.
Number of employees per page. If None, server default is used.
Filter employees by name.
Page number to retrieve, must be >= 1.
Filter employees by email address.
Filter employees by active status (true or false).
Filter employees by creation date. Use operators like 'eq', 'gt', 'gte', 'lt', 'lte'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_INVENTORY_BREAKDOWNSTool 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
Sort results by field. Prefix with '-' for descending order.
Specify which fields to return in the response.
Comma-separated list of related resources to include. Available: product, location, inventory_levels.
Number of items per page, must be >= 1.
Page number for pagination, must be >= 1.
Status of inventory breakdowns to retrieve. This is a required filter.
Filter by specific product ID. Either product_id or product_group_id must be specified.
Filter by product group ID. Either product_id or product_group_id must be specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_ITEMSTool to retrieve a list of items (products and product groups). Use when you need to browse the catalog with pagination and filtering.
Input parameters
Sort order using field names. Prefix with '-' for descending order. Example: 'name' or '-created_at'
Specify which fields to include instead of defaults. Example: \['id', 'name', 'slug'\]
Load related resources (comma-separated). Example: 'photos,properties'
Number of items per page (e.g., '10', '25', '50').
Filter items by name.
Filter items by slug.
Pagination page number to retrieve.
Filter items by archived status.
Filter items by product type (e.g., 'rental', 'sales_item').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_LINESTool 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
Sort results by attributes. Prefix with '-' for descending order (e.g., '-created_at').
Specify which fields to include instead of defaults.
Sideload related resources (comma-separated). Supported: order, product, tax_category.
Filter lines by ID.
Number of items per page for pagination.
Page number for pagination. Must be >= 1.
Filter lines by title.
Filter lines by taxable status.
Filter lines by archived status.
Filter lines by order ID.
Filter lines by quantity.
Filter lines by creation date. Use ISO 8601 format or comparison operators.
Filter lines by product ID.
Filter lines by last update date. Use ISO 8601 format or comparison operators.
Filter lines by discountable status.
Filter lines by tax category ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_LOCATIONSTool to retrieve a list of locations from Booqable. Use when you need to view available locations with pagination, filtering, or sorting options.
Input parameters
Metadata requests (e.g., total\[\]=count for total count).
Sort by attributes using format: field1,-field2 (minus prefix for descending).
List of specific fields to include instead of defaults.
Comma-separated list of relationships to sideload (e.g., photo).
Filter by location ID.
Number of items per page for pagination.
Filter by location name.
Filter by location slug.
Page number for pagination, must be >= 1.
Filter by archived status.
Filter by created_at timestamp (use operators like \[gt\], \[lt\], \[gte\], \[lte\]).
Filter by updated_at timestamp (use operators like \[gt\], \[lt\], \[gte\], \[lte\]).
Filter by archived_at timestamp (use operators like \[gt\], \[lt\], \[gte\], \[lte\]).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_NOTESTool to retrieve a list of notes. Use when you need to list notes with optional filtering by owner, date, or content.
Input parameters
How to sort the data. Format: 'attribute1,-attribute2' where '-' prefix means descending order.
List of fields to include instead of default fields. Examples: 'id', 'body', 'owner_id', 'owner_type', 'created_at', 'updated_at'.
Comma-separated list of relationships to include. Acceptable: 'owner'.
Filter notes by ID. Supports exact match or operators.
Number of notes per page.
Filter notes by text content (searches in body field).
Page number to retrieve, must be >= 1.
Filter notes by owner ID (the resource this note is attached to).
Filter notes by creation date. Use operators like 'gt', 'gte', 'lt', 'lte' with ISO8601 timestamps.
Filter notes by owner type (e.g., 'customers', 'orders').
Filter notes by last update date. Use operators like 'gt', 'gte', 'lt', 'lte' with ISO8601 timestamps.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_ORDERSTool 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
Sort results by attributes. Prefix with '-' for descending order (e.g., '-created_at').
Specify which fields to include instead of defaults. Example: \['id', 'number', 'status'\]
Sideload related resources (comma-separated). Supported: customer, coupon, start_location.
Number of items per page for pagination.
Page number for pagination.
Filter orders by order number.
Filter orders by order status (e.g., reserved, confirmed).
Filter orders by archived status.
Filter orders by rental end date. Use ISO 8601 format or comparison operators.
Filter orders by rental start date. Use ISO 8601 format or comparison operators.
Filter orders by creation date. Use ISO 8601 format or comparison operators.
Filter orders by last update date. Use ISO 8601 format or comparison operators.
Filter orders by customer ID.
Filter orders by tax region ID.
Filter orders by payment status.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PAYMENT_METHODSTool 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
Sends metadata with the request as a JSON object.
Controls data ordering. Prefix with '-' for descending order (e.g., '-created_at').
Allows selection of specific attributes to include in the response.
Loads associated resources (sideloading). Comma-separated list of relationships.
Sets the quantity of items per page.
Specifies which page to retrieve, must be >= 1.
Filter by payment method ID (equal). Format: UUID.
Filter by payment method ID (not equal). Format: UUID.
Filter by status (equal). Possible values depend on the API specification.
Filter by creation date (equal). Format: ISO 8601 datetime.
Filter by creation date (greater than). Format: ISO 8601 datetime.
Filter by creation date (less than). Format: ISO 8601 datetime.
Filter by creation date (greater than or equal). Format: ISO 8601 datetime.
Filter by creation date (less than or equal). Format: ISO 8601 datetime.
Filter by customer ID (equal). Format: UUID.
Filter by customer ID (not equal). Format: UUID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PAYMENTSTool 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
Request metadata like aggregation counts. Use format: meta\[total\]\[\]=count
Sort by fields. Use - prefix for descending order (e.g., -created_at).
Specify which fields to return instead of defaults. Provide as a list of field names.
Sideload related resources (comma-separated list of relationships).
Filter by payment ID (uuid).
Items per page for pagination.
Page number for pagination.
Filter by order ID (uuid).
Filter by created_at datetime. Use operators like filter\[created_at\]\[gte\]=2024-01-01.
Filter by payment method.
Filter by payment status.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PHOTOSTool 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
Sort results by attributes. Prefix with '-' for descending order (e.g., '-created_at').
Specify which fields to include instead of defaults. Example: \['id', 'filename', 'alt_text'\]
Sideload related resources (comma-separated). Example: 'owner'
Number of items per page for pagination.
Page number for pagination. Must be >= 1.
Filter photos by owner ID (UUID format).
Filter photos by owner type (e.g., 'products', 'product_groups').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PLANNINGSTool 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
Sort order (e.g., 'starts_at' for ascending, '-starts_at' for descending).
List of specific fields to include in the response instead of defaults.
Comma-separated list of relationships to include (e.g., 'product', 'bundle', 'location', 'order').
Number of plannings per page.
Page number to retrieve, must be >= 1.
Filter plannings by item ID (products or bundles).
Filter plannings by order ID.
Filter plannings with reserved_from at or after this date-time (ISO 8601 format).
Filter plannings with reserved_till at or before this date-time (ISO 8601 format).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PRICE_RULESETSTool 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
Sort criteria. Prefix with - for descending. Example: name or -created_at
Comma-separated fields to return instead of defaults. Example: id,name
Comma-separated relationships to sideload. Available: price_rules
Filter by price ruleset ID (UUID). Supports eq, not_eq operators.
Number of items per page.
Filter by name. Supports eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match operators.
Page number to retrieve, must be >= 1.
Filter by archived status. True returns only archived rulesets, false returns non-archived.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PRICE_STRUCTURESTool 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
Sort criteria. Prefix with - for descending. Example: name or -created_at
Comma-separated fields to return instead of defaults. Example: id,name,created_at
Comma-separated relationships to sideload. Available: price_tiles
Filter by price structure ID (UUID). Supports eq, not_eq operators.
Number of items per page.
Filter by name. Supports eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match operators.
Page number to retrieve, must be >= 1.
Filter by product group ID (UUID). Supports eq, not_eq operators.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PRODUCT_GROUPSTool 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
Field to sort by. Prefix with '-' for descending order (e.g., '-created_at' for newest first).
List of fields to include in the response (e.g., \['id', 'name', 'slug'\]). If not specified, all fields are returned.
Filter criteria to apply. Use syntax like 'archived:false' or 'product_type:rental'.
Comma-separated list of relationships to include (e.g., 'photo,tax_category').
Number of items per page. If not specified, server default is used.
Page number to retrieve. Defaults to 1 if not specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PRODUCTSTool to retrieve a list of products. Use when you need to browse products with pagination and filtering.
Input parameters
Sort order using field names. Prefix with '-' for descending order. Example: 'name' or '-created_at'
Specify which fields to include instead of defaults. Example: \['id', 'name', 'slug'\]
Load related resources (comma-separated). Available: 'photos', 'inventory_levels', 'tax_category', 'product_group'. Example: 'photos,product_group'
Number of products per page (e.g., '10', '25', '50').
Filter products by name.
Pagination page number to retrieve.
Filter products by taxable status.
Filter products by archived status.
Filter products by tag.
Filter products by discountable status.
Filter products by product group ID (UUID).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PROPERTIESTool 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
Request metadata like aggregations. Use syntax like 'total\[\]=count'.
Sort order. Prefix with '-' for descending. Examples: 'name', '-created_at', 'property_type'.
Specify which fields to return instead of defaults. Use field names like 'name', 'value', 'property_type'.
Apply filters using syntax like 'name eq value' or 'owner_id eq uuid'. Supports operators: eq, neq, gt, gte, lt, lte.
Sideload related resources (comma-separated). Available: owner, default_property.
Number of items per page, must be >= 1.
Page number for pagination, must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_PROVINCESTool to retrieve a list of provinces. Use when you need to list available provinces, optionally filtered by country.
Input parameters
Sort order for provinces. Use field name for ascending, prefix with minus for descending (e.g., 'name' or '-name').
Filter conditions to apply. Supports filtering by country_id, name, created_at, updated_at, id.
Number of provinces per page. If None, server default is used.
Page number to retrieve, must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_STOCK_ITEM_PLANNINGSTool to retrieve a list of stock item plannings. Use when you need to list stock item plannings with filtering and pagination.
Input parameters
Include metadata like total count. Use 'total_count' to include count.
Sort criteria using format attribute1,-attribute2. Prefix with '-' for descending order.
Comma-separated fields to return in the response.
Comma-separated list of related resources to sideload (e.g., 'stock_item,planning').
Filter by id with operators: eq, not_eq. Format: operator:value.
Number of stock item plannings per page.
Page number to retrieve, must be >= 1.
Filter by archived status (true or false).
Filter by created_at with operators: eq, not_eq, gt, gte, lt, lte. Format: operator:value (e.g., 'gte:2024-01-01').
Filter by planning_id with operators: eq, not_eq. Format: operator:value.
Filter by stock_item_id with operators: eq, not_eq. Format: operator:value.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_STOCK_ITEMSTool 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
Sort order for the results (e.g., 'created_at' for ascending, '-created_at' for descending).
Comma-separated list of fields to include in the response (e.g., 'id,barcode,status').
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.
Comma-separated list of related resources to include (sideload) in the response.
Number of stock items per page. Used to control pagination size.
The page number to retrieve. Used for pagination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_TAX_RATESTool to retrieve a list of tax rates. Use when you need to list or search for tax rates with pagination and filtering.
Input parameters
Sort order for the results. Use field name optionally prefixed with '-' for descending order (e.g., 'name' or '-created_at').
List of specific fields to include in the response instead of default fields.
Comma-separated list of relationships to sideload (e.g., 'tax_category,region').
Filter by tax rate ID using exact match.
The number of items per page.
Filter by tax rate name.
The page number to request for pagination.
Filter by region ID.
Filter by percentage value.
Filter by tax category ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_TAX_VALUESTool to retrieve a list of tax values. Use when you need to fetch tax rates with optional filtering, pagination, and sorting.
Input parameters
Sort results by attributes. Use '-' prefix for descending order (e.g., 'created_at' or '-percentage').
Comma-separated list of relationships to include (e.g., 'tax_category').
Filter by exact match. Provide field name and value (e.g., {'tax_category_id': 'uuid'}).
Number of tax values per page.
Page number to retrieve for pagination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_LIST_USERSTool to retrieve a list of users from Booqable. Use when you need to list user accounts with pagination and filtering options.
Input parameters
Sort order (e.g., 'name' for ascending, '-name' for descending). Comma-separated for multiple fields.
Specify which user fields to return. If not provided, all default fields are returned.
Sideload relationships (e.g., 'company'). Use comma-separated values for multiple relationships.
Number of users per page. If None, server default is used.
Filter users by name.
Page number to retrieve, must be >= 1.
Filter users by email address.
Filter users by disabled status (true or false).
Filter users by creation date. Use operators like 'eq', 'gt', 'gte', 'lt', 'lte'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_SEARCH_BUNDLESTool 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
Fields specification for bundle resources.
Filter structure for searching bundles.
Number of bundles per page. If not specified, server default is used.
Page number to retrieve, must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_SEARCH_CUSTOMERSTool to search customers in the Booqable system. Use when you need to retrieve customer data with optional field selection and relationship inclusion.
Input parameters
Comma-separated list of relationships to include (e.g., 'orders,notes').
Number of customers per page. If not specified, server default is used.
Page number to retrieve, must be >= 1.
Comma-separated list of customer fields to return (e.g., 'id,name,email'). If not specified, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_SEARCH_DOCUMENTSTool 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
Object specifying which fields to return for documents.
Filter conditions as field-operator-value pairs (e.g., {'status': {'eq': 'confirmed'}, 'archived': {'eq': false}}). Multiple fields act as implicit AND.
Number of documents per page. If not specified, server default is used.
Page number to retrieve, must be >= 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_SEARCH_ITEMSTool 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
Comma-separated list of relationships to include (e.g., 'photo,tax_category').
Number of items per page. If not specified, server default is used.
Page number to retrieve, must be >= 1.
Comma-separated list of item fields to return (e.g., 'id,name,product_type,sku'). If not specified, all fields are returned.
Filter conditions with logical operator.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_SEARCH_ORDERSTool 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
Comma-separated list of relationships to sideload (e.g., 'customer,lines,plannings').
Number of orders per page. If not specified, server default is used.
Page number to retrieve, must be >= 1.
Comma-separated list of order fields to return (e.g., 'id,number,status,customer_id'). If not specified, all fields are returned.
Filter conditions with logical operator for order search.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_SEARCH_PLANNINGSTool 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
Field selection specification for controlling response fields.
Comma-separated list of relationships to include (e.g., 'product', 'bundle', 'location', 'order').
Number of plannings per page. If not specified, server default is used.
Page number to retrieve, must be >= 1.
Filter conditions with logical operator for advanced search.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOOQABLE_UPDATE_COMPANIESTool 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
City name
Company name
Company email address
Company phone number
State or region
Country name
Company website URL
Postal/ZIP code
Company timezone (e.g., 'America/New_York', 'Europe/Amsterdam')
VAT or tax identification number
Billing email address (if different from main email)
First line of the company address
Second line of the company address (optional)
Whether to use a separate billing address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 41 agents privately built on Nagent that already use Booqable.
Build on Nagent
Connect Booqable to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Booqable, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Booqable is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Booqable is connected, you configure its 49 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Booqable steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Booqable event fires, the agent kicks off automatically.
Every Booqable action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Booqable ships with 49 pre-built scheduling & booking actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Booqable together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Booqable-based workflows tailored to your business.