- Category: internet of things
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 19
- Triggers: 0
- Slug:
HOTSPOTSYSTEM - Version: 20261101_00
Tools
List Customers
List Customers
Slug:
HOTSPOTSYSTEM_CUSTOMERS_LISTLists all customers in the HotspotSystem account with optional filtering. Use this tool to: - Retrieve all customers with their details (name, email, contact info, registration date, etc.) - Paginate through large customer lists using limit and offset parameters - Sort customers by any field in ascending or descending order - Filter response to only include specific fields to reduce payload size Returns metadata with total customer count and an array of customer objects.Input Parameters
Field name to sort results by. Prepend ’-’ for descending order (e.g., ‘-customer_name’ for reverse alphabetical by name). Common fields: customer_name, email, registered_at.
Maximum number of customers to return in a single response. Defaults to 100 if not specified.
Comma-separated list of specific field names to include in each customer object. If omitted, all fields are returned. Available fields include: customer_id, customer_name, user_name, email, company_name, address, city, state, zip, country_code, phone, registered_at.
Number of customers to skip before starting to return results (for pagination). Defaults to 0.
Output
List Customers by Location
List Customers by Location
Slug:
HOTSPOTSYSTEM_CUSTOMERS_LIST_BY_LOCATIONLists customers associated with a specified HotspotSystem location. Supports selecting fields, sorting, and pagination using limit and offset.Input Parameters
Comma-separated list of fields to include in the response. Available fields: id, user_name, name, email, company_name, address, city, state, zip, country_code, phone, registered_at. If omitted, all fields are returned.
Number of customers to skip before returning results (for pagination); must be >= 0. Use with limit to paginate through results.
Output
Generate Voucher (v1)
Generate Voucher (v1)
Slug:
HOTSPOTSYSTEM_GENERATE_VOUCHER_V1Generates a single-use hotspot access voucher for a specified location using its available voucher credits. Optionally specify the location or location group where it can be activated and a custom package; otherwise, the location and its default free access are used.Input Parameters
Custom package ID defining voucher parameters. Defaults to the location’s default free access if omitted.
Location ID or location group ID where the voucher can be activated. Defaults to the same location if omitted.
ID of the location from which voucher credits will be deducted. Obtain valid location IDs using the List Locations action. The location must have available voucher credits.
Output
Get Locations Options
Get Locations Options
Get Me
Get Me
List Paid Transactions
List Paid Transactions
Slug:
HOTSPOTSYSTEM_LIST_PAID_TRANSACTIONSTool to list paid transactions globally across all locations. Use when you need to retrieve all paid transaction records with optional pagination and sorting.Input Parameters
Sort by any field; prepend ’-’ for descending order (e.g., ‘-action_date_gmt’ for newest first)
Comma-separated list of field names to include in the response. Available fields: id, operator, location_id, user_name, customer, action_date_gmt, amount, currency, user_agent, newsletter, company_name, email, address, city, state, zip, country_code, phone, language, smscountry
Output
List Locations
List Locations
Misc Ping
Misc Ping
List Subscribers
List Subscribers
Slug:
HOTSPOTSYSTEM_SUBSCRIBERS_LISTLists newsletter subscribers across locations with optional field selection, sorting and pagination. Subscriber information can include contact details and social network data.Input Parameters
Field name to sort results by. Prepend ’-’ for descending order. Examples: ‘email’ (ascending A-Z), ‘-registered_at’ (newest first), ‘name’ (ascending A-Z). Can sort by any subscriber field.
Maximum number of subscribers to return per request. Must be >= 1. Use with offset for pagination through large result sets. Default is API-determined if not specified.
Comma-separated list of subscriber fields to include in response. Reduces response size by returning only specified fields. Available fields: id, username, name, email, company_name, address, city, state, zip, country_code, phone, social_network, social_id, social_username, social_link, social_gender, social_age_range, social_followers_count, registered_at. Example: ‘id,email,name’ returns only ID, email, and name fields.
Number of subscribers to skip before returning results. Must be >= 0. Use with limit for pagination. Example: limit=10, offset=0 returns first 10; limit=10, offset=10 returns next 10.
Output
List Subscribers by Location
List Subscribers by Location
List MAC Transactions
List MAC Transactions
List MAC Transactions by Location
List MAC Transactions by Location
Slug:
HOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC_BY_LOCATIONLists MAC address authentication transactions for a specific location, with optional field selection, sorting and pagination. Records can include customer data and custom fields.Input Parameters
Comma-separated list of field names to include in the response. Available fields: id, operator, location_id, user_name, action_date_gmt, package_id, user_agent, customer fields (email, address, city, state, zip, country_code, phone), and custom questions/answers (q1-q5, a1-a5)
Output
List Paid Transactions by Location
List Paid Transactions by Location
List Voucher Transactions
List Voucher Transactions
Slug:
HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHERTool to list voucher transactions globally across all locations.Input Parameters
Sort by any field; prepend ’-’ for descending order (e.g., ‘-action_date_gmt’ for newest first)
Comma-separated list of field names to include in the response. Available fields: id, operator, location_id, user_name, customer, action_date_gmt, amount, currency, user_agent, newsletter, company_name, email, address, city, state, zip, country_code, phone, language, smscountry
Output
List Voucher Transactions by Location
List Voucher Transactions by Location
List Vouchers
List Vouchers
Vouchers List by Location
Vouchers List by Location
Slug:
HOTSPOTSYSTEM_VOUCHERS_LIST_BY_LOCATIONLists vouchers for a specific HotspotSystem location, with optional field selection, sorting, and pagination. Voucher details include access codes, usage limits, validity, and pricing; the v1 fallback supplies defaults for missing fields.Input Parameters
Field name to sort results by. Prepend ’-’ for descending order (e.g., ‘-validity’ sorts by validity descending, ‘price_enduser’ sorts by price ascending).
Comma-separated list of voucher fields to include in the response (e.g., ‘serial,voucher_code,validity’). If omitted, all fields are returned.
Number of vouchers to skip before returning results (minimum 0). Use with limit for pagination. For example, offset=10 with limit=5 returns vouchers 11-15.
The unique identifier of the location. Obtain location IDs using the Locations List action.