Skip to main content
Hotspotsystem logo
  • Category: internet of things
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 19
  • Triggers: 0
  • Slug: HOTSPOTSYSTEM
  • Version: 20261101_00

Tools

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

string
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.
integer
Maximum number of customers to return in a single response. Defaults to 100 if not specified.
string
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.
integer
Number of customers to skip before starting to return results (for pagination). Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Property name to sort by; prepend ’-’ for descending order (e.g., ‘-registered_at’)
integer
Number of items to return per page; must be >= 1
string
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.
integer
Number of customers to skip before returning results (for pagination); must be >= 0. Use with limit to paginate through results.
string
required
Unique identifier of the HotspotSystem location to query customers from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string ("json" | "xml")
Response format, either ‘json’ or ‘xml’. Defaults to ‘json’.
string
Custom package ID defining voucher parameters. Defaults to the location’s default free access if omitted.
string
Location ID or location group ID where the voucher can be activated. Defaults to the same location if omitted.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_GET_LOCATIONS_OPTIONSTool to get simplified list of locations as dropdown options. Returns only id/name pairs for each location. Use when you need location options for selection menus or dropdowns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_GET_METool to verify the resource owner’s credentials and retrieve authenticated user information. Use when you need to confirm authentication status or get the current user’s ID and operator name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Sort by any field; prepend ’-’ for descending order (e.g., ‘-action_date_gmt’ for newest first)
integer
Maximum number of items to return per page; must be >= 1
string
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
integer
Zero-based offset for pagination; must be >= 0 (use with limit for paging)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_LOCATIONS_LISTLists the resource owner’s locations with optional field selection, sorting and pagination.

Input Parameters

string
Property name to sort by; prepend ’-’ for descending order.
integer
Number of items to return per page; must be >= 1.
string
Comma-separated location property names to include in the response.
integer
Zero-based page offset; must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_MISC_PINGTool to perform health check against the HotspotSystem API. Use when verifying connectivity and availability.

Input Parameters

string
Additional optional query parameter for edge-case testing (unicode/special chars).
string
Optional echo value sent as query parameter for testing; the API ignores it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
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.
integer
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.
string
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.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_SUBSCRIBERS_LIST_BY_LOCATIONTool to list subscribers by location. Use when you need to retrieve subscribers for a specific location with optional field selection, sorting, and pagination.

Input Parameters

string
Property name to sort by; prepend ’-’ for descending order (e.g., ‘-registered_at’)
integer
Number of items to return per page; must be >= 1
string
Comma-separated list of fields to include in the response (e.g., ‘id,email,name’)
integer
Zero-based page index when paginating; must be >= 0
string
required
ID of the location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_TRANSACTIONS_LIST_MACTool to list MAC-based transactions. Use when you need to retrieve MAC transaction records with optional pagination and sorting.

Input Parameters

string
Sort by any field; prepend ’-’ for descending order.
integer
Maximum number of items to return; must be >= 1.
string
Comma-separated list of field names to include in the response.
integer
Zero-based offset for pagination; must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Sort by any field; prepend ’-’ for descending order
integer
Maximum number of items to return; must be >= 1
string
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)
integer
Zero-based offset for pagination; must be >= 0
string
required
ID of the location to retrieve MAC transactions for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_TRANSACTIONS_LIST_PAID_BY_LOCATIONTool to list paid transactions by location. Use when you need to retrieve paid transaction records for a specific location with optional pagination and sorting.

Input Parameters

string
Sort by any field; prepend ’-’ for descending order
integer
Maximum number of items to return; must be >= 1
string
Comma-separated list of field names to include in the response
integer
Zero-based offset for pagination; must be >= 0
string
required
ID of the location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIALTool to list social transactions. Use when you need to retrieve social transaction records with optional pagination and sorting.

Input Parameters

string
Sort by any field; prepend ’-’ for descending order.
integer
Maximum number of items to return; must be >= 1.
string
Comma-separated list of field names to include in the response.
integer
Zero-based offset for pagination; must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIAL_BY_LOCATIONTool to list social transactions by location. Use when you need to retrieve social transaction records for a specific location with optional pagination and sorting.

Input Parameters

string
Sort by any field; prepend ’-’ for descending order
integer
Maximum number of items to return; must be >= 1
string
Comma-separated list of field names to include in the response
integer
Zero-based offset for pagination; must be >= 0
string
required
ID of the location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHERTool to list voucher transactions globally across all locations.

Input Parameters

string
Sort by any field; prepend ’-’ for descending order (e.g., ‘-action_date_gmt’ for newest first)
integer
Maximum number of items to return per page; must be >= 1
string
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
integer
Zero-based offset for pagination; must be >= 0 (use with limit for paging)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER_BY_LOCATIONLists voucher transaction records for a specific HotspotSystem location. Select response fields, sort the records, and use limit and offset to paginate through the results.

Input Parameters

string
Sort by any field; prepend ’-’ for descending order
integer
Maximum number of items to return; must be >= 1
string
Comma-separated list of field names to include in the response
integer
Zero-based offset for pagination; must be >= 0
string
required
ID of the location

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HOTSPOTSYSTEM_VOUCHERS_LISTLists the resource owner’s vouchers across locations. Select which voucher properties to return, sort the results, and use limit and offset to paginate.

Input Parameters

string
Property name to sort by; prepend ’-’ for descending order.
integer
Number of items to return per page; must be >= 1.
string
Comma-separated voucher property names to return.
integer
Zero-based page index when paginated by limit; must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Field name to sort results by. Prepend ’-’ for descending order (e.g., ‘-validity’ sorts by validity descending, ‘price_enduser’ sorts by price ascending).
integer
Maximum number of vouchers to return per page (minimum 1). Use with offset for pagination.
string
Comma-separated list of voucher fields to include in the response (e.g., ‘serial,voucher_code,validity’). If omitted, all fields are returned.
integer
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.
string
required
The unique identifier of the location. Obtain location IDs using the Locations List action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not