> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Hotspotsystem

> HotspotSystem provides public Wi-Fi hotspot management and billing services for businesses.

![Hotspotsystem logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/hotspotsystem.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=0c0502dc72b241a25fdb117d67cef012)

* **Category:** internet of things
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 19
* **Triggers:** 0
* **Slug:** `HOTSPOTSYSTEM`
* **Version:** 20261101\_00

## Tools

> [accordion] List Customers
>
> **Slug:** `HOTSPOTSYSTEM_CUSTOMERS_LIST`
>
> Lists 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
>
> **sort** `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.
>
> **limit** `integer`
>
> Maximum number of customers to return in a single response. Defaults to 100 if not specified.
>
> **fields** `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.
>
> **offset** `integer`
>
> Number of customers to skip before starting to return results (for pagination). Defaults to 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers by Location
>
> **Slug:** `HOTSPOTSYSTEM_CUSTOMERS_LIST_BY_LOCATION`
>
> Lists customers associated with a specified HotspotSystem location. Supports selecting fields, sorting, and pagination using limit and offset.
>
> #### Input Parameters
>
> **sort** `string`
>
> Property name to sort by; prepend '-' for descending order (e.g., '-registered\_at')
>
> **limit** `integer`
>
> Number of items to return per page; must be >= 1
>
> **fields** `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.
>
> **offset** `integer`
>
> Number of customers to skip before returning results (for pagination); must be >= 0. Use with limit to paginate through results.
>
> **location\_id** `string` *required*
>
> Unique identifier of the HotspotSystem location to query customers from
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Voucher (v1)
>
> **Slug:** `HOTSPOTSYSTEM_GENERATE_VOUCHER_V1`
>
> Generates 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
>
> **format** `string ("json" | "xml")`
>
> Response format, either 'json' or 'xml'. Defaults to 'json'.
>
> **package** `string`
>
> Custom package ID defining voucher parameters. Defaults to the location's default free access if omitted.
>
> **validity** `string`
>
> Location ID or location group ID where the voucher can be activated. Defaults to the same location if omitted.
>
> **location\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Locations Options
>
> **Slug:** `HOTSPOTSYSTEM_GET_LOCATIONS_OPTIONS`
>
> Tool 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Me
>
> **Slug:** `HOTSPOTSYSTEM_GET_ME`
>
> Tool 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Paid Transactions
>
> **Slug:** `HOTSPOTSYSTEM_LIST_PAID_TRANSACTIONS`
>
> Tool 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** `string`
>
> Sort by any field; prepend '-' for descending order (e.g., '-action\_date\_gmt' for newest first)
>
> **limit** `integer`
>
> Maximum number of items to return per page; must be >= 1
>
> **fields** `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
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0 (use with limit for paging)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Locations
>
> **Slug:** `HOTSPOTSYSTEM_LOCATIONS_LIST`
>
> Lists the resource owner's locations with optional field selection, sorting and pagination.
>
> #### Input Parameters
>
> **sort** `string`
>
> Property name to sort by; prepend '-' for descending order.
>
> **limit** `integer`
>
> Number of items to return per page; must be >= 1.
>
> **fields** `string`
>
> Comma-separated location property names to include in the response.
>
> **offset** `integer`
>
> Zero-based page offset; must be >= 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Misc Ping
>
> **Slug:** `HOTSPOTSYSTEM_MISC_PING`
>
> Tool to perform health check against the HotspotSystem API. Use when verifying connectivity and availability.
>
> #### Input Parameters
>
> **q** `string`
>
> Additional optional query parameter for edge-case testing (unicode/special chars).
>
> **echo** `string`
>
> Optional echo value sent as query parameter for testing; the API ignores it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscribers
>
> **Slug:** `HOTSPOTSYSTEM_SUBSCRIBERS_LIST`
>
> Lists newsletter subscribers across locations with optional field selection, sorting and pagination. Subscriber information can include contact details and social network data.
>
> #### Input Parameters
>
> **sort** `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.
>
> **limit** `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.
>
> **fields** `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.
>
> **offset** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subscribers by Location
>
> **Slug:** `HOTSPOTSYSTEM_SUBSCRIBERS_LIST_BY_LOCATION`
>
> Tool 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
>
> **sort** `string`
>
> Property name to sort by; prepend '-' for descending order (e.g., '-registered\_at')
>
> **limit** `integer`
>
> Number of items to return per page; must be >= 1
>
> **fields** `string`
>
> Comma-separated list of fields to include in the response (e.g., 'id,email,name')
>
> **offset** `integer`
>
> Zero-based page index when paginating; must be >= 0
>
> **location\_id** `string` *required*
>
> ID of the location
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List MAC Transactions
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC`
>
> Tool to list MAC-based transactions. Use when you need to retrieve MAC transaction records with optional pagination and sorting.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order.
>
> **limit** `integer`
>
> Maximum number of items to return; must be >= 1.
>
> **fields** `string`
>
> Comma-separated list of field names to include in the response.
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List MAC Transactions by Location
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC_BY_LOCATION`
>
> Lists 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
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order
>
> **limit** `integer`
>
> Maximum number of items to return; must be >= 1
>
> **fields** `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)
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0
>
> **location\_id** `string` *required*
>
> ID of the location to retrieve MAC transactions for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Paid Transactions by Location
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_PAID_BY_LOCATION`
>
> Tool 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
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order
>
> **limit** `integer`
>
> Maximum number of items to return; must be >= 1
>
> **fields** `string`
>
> Comma-separated list of field names to include in the response
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0
>
> **location\_id** `string` *required*
>
> ID of the location
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Social Transactions
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIAL`
>
> Tool to list social transactions. Use when you need to retrieve social transaction records with optional pagination and sorting.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order.
>
> **limit** `integer`
>
> Maximum number of items to return; must be >= 1.
>
> **fields** `string`
>
> Comma-separated list of field names to include in the response.
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Social Transactions by Location
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIAL_BY_LOCATION`
>
> Tool 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
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order
>
> **limit** `integer`
>
> Maximum number of items to return; must be >= 1
>
> **fields** `string`
>
> Comma-separated list of field names to include in the response
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0
>
> **location\_id** `string` *required*
>
> ID of the location
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Voucher Transactions
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER`
>
> Tool to list voucher transactions globally across all locations.
>
> #### Input Parameters
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order (e.g., '-action\_date\_gmt' for newest first)
>
> **limit** `integer`
>
> Maximum number of items to return per page; must be >= 1
>
> **fields** `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
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0 (use with limit for paging)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Voucher Transactions by Location
>
> **Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER_BY_LOCATION`
>
> Lists 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
>
> **sort** `string`
>
> Sort by any field; prepend '-' for descending order
>
> **limit** `integer`
>
> Maximum number of items to return; must be >= 1
>
> **fields** `string`
>
> Comma-separated list of field names to include in the response
>
> **offset** `integer`
>
> Zero-based offset for pagination; must be >= 0
>
> **location\_id** `string` *required*
>
> ID of the location
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Vouchers
>
> **Slug:** `HOTSPOTSYSTEM_VOUCHERS_LIST`
>
> Lists 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
>
> **sort** `string`
>
> Property name to sort by; prepend '-' for descending order.
>
> **limit** `integer`
>
> Number of items to return per page; must be >= 1.
>
> **fields** `string`
>
> Comma-separated voucher property names to return.
>
> **offset** `integer`
>
> Zero-based page index when paginated by limit; must be >= 0.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Vouchers List by Location
>
> **Slug:** `HOTSPOTSYSTEM_VOUCHERS_LIST_BY_LOCATION`
>
> Lists 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
>
> **sort** `string`
>
> Field name to sort results by. Prepend '-' for descending order (e.g., '-validity' sorts by validity descending, 'price\_enduser' sorts by price ascending).
>
> **limit** `integer`
>
> Maximum number of vouchers to return per page (minimum 1). Use with offset for pagination.
>
> **fields** `string`
>
> Comma-separated list of voucher fields to include in the response (e.g., 'serial,voucher\_code,validity'). If omitted, all fields are returned.
>
> **offset** `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.
>
> **location\_id** `string` *required*
>
> The unique identifier of the location. Obtain location IDs using the Locations List action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
