# Hotspotsystem

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

- **Category:** internet of things
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 19
- **Triggers:** 0
- **Slug:** `HOTSPOTSYSTEM`
- **Version:** 20260223_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | 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 | No | Maximum number of customers to return in a single response. Defaults to 100 if not specified. |
| `fields` | string | No | 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 | No | Number of customers to skip before starting to return results (for pagination). Defaults to 0. |

#### 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 Customers by Location

**Slug:** `HOTSPOTSYSTEM_CUSTOMERS_LIST_BY_LOCATION`

Lists all customers associated with a specific HotspotSystem location. Use this tool to: - Retrieve customer details (name, email, contact info, registration date) for a specific location - Paginate through large customer lists using limit and offset parameters - Sort customers by any field (prepend '-' for descending order, e.g., '-registered_at') - Filter response to include only specific fields to reduce payload size - Query customers at different locations by location ID Returns metadata with total customer count and an array of customer objects. Note: Empty results (total_count: 0) indicate no customers are registered at the specified location.

#### Input Parameters

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

#### 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 |

### Generate Voucher (v1)

**Slug:** `HOTSPOTSYSTEM_GENERATE_VOUCHER_V1`

Generates an access voucher code on-demand for a specific location. This action creates a single-use voucher that can be used for hotspot access. The voucher is generated against available voucher credits in the specified location. Use this when you need to provide immediate access codes to users. Note: Requires an active location with available voucher credits (use the List Locations action first to get valid location_id values).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "xml") | No | Response format, either 'json' or 'xml'. Defaults to 'json'. |
| `package` | string | No | Custom package ID defining voucher parameters. Defaults to the location's default free access if omitted. |
| `validity` | string | No | Location ID or location group ID where the voucher can be activated. Defaults to the same location if omitted. |
| `location_id` | string | Yes | 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

| 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 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

| 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 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

| 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 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

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

#### 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:** `HOTSPOTSYSTEM_LOCATIONS_LIST`

Tool to list the resource owner's locations. Use when you need to retrieve locations with optional filtering, sorting, or pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Property name to sort by; prepend '-' for descending order. |
| `limit` | integer | No | Number of items to return per page; must be >= 1. |
| `fields` | string | No | Comma-separated location property names to include in the response. |
| `offset` | integer | No | Zero-based page offset; must be >= 0. |

#### 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 |

### Misc Ping

**Slug:** `HOTSPOTSYSTEM_MISC_PING`

Tool to perform health check against the HotspotSystem API. Use when verifying connectivity and availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Additional optional query parameter for edge-case testing (unicode/special chars). |
| `echo` | string | No | Optional echo value sent as query parameter for testing; the API ignores it. |

#### 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 Subscribers

**Slug:** `HOTSPOTSYSTEM_SUBSCRIBERS_LIST`

List newsletter subscribers across all locations with optional filtering, sorting, and pagination. Returns subscriber information including contact details (name, email, phone, address) and social network data (Facebook, Google, etc.). Supports field selection to retrieve only needed properties, sorting by any field (ascending or descending), and pagination with limit/offset for large result sets. Use this tool when you need to: - Retrieve all subscribers for the account - Filter subscribers by specific fields - Sort subscribers by registration date, name, email, etc. - Paginate through large subscriber lists

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | 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 | No | 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 | No | 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 | No | 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

| 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 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Property name to sort by; prepend '-' for descending order (e.g., '-registered_at') |
| `limit` | integer | No | Number of items to return per page; must be >= 1 |
| `fields` | string | No | Comma-separated list of fields to include in the response (e.g., 'id,email,name') |
| `offset` | integer | No | Zero-based page index when paginating; must be >= 0 |
| `location_id` | string | Yes | ID of the 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 |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by any field; prepend '-' for descending order. |
| `limit` | integer | No | Maximum number of items to return; must be >= 1. |
| `fields` | string | No | Comma-separated list of field names to include in the response. |
| `offset` | integer | No | Zero-based offset for pagination; must be >= 0. |

#### 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 MAC Transactions by Location

**Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC_BY_LOCATION`

Lists MAC address authentication transactions for a specific location. MAC (Media Access Control) transactions track network access granted based on device MAC addresses. Use this action when you need to: - View MAC-based authentication history for a specific location - Monitor which devices accessed the network via MAC authentication - Retrieve transaction records with customer data and custom fields - Filter and paginate MAC transaction records for reporting For transactions across all locations, use the global MAC transactions endpoint instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by any field; prepend '-' for descending order |
| `limit` | integer | No | Maximum number of items to return; must be >= 1 |
| `fields` | string | No | 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 | No | Zero-based offset for pagination; must be >= 0 |
| `location_id` | string | Yes | ID of the location to retrieve MAC transactions for |

#### 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 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by any field; prepend '-' for descending order |
| `limit` | integer | No | Maximum number of items to return; must be >= 1 |
| `fields` | string | No | Comma-separated list of field names to include in the response |
| `offset` | integer | No | Zero-based offset for pagination; must be >= 0 |
| `location_id` | string | Yes | ID of the 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 |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by any field; prepend '-' for descending order. |
| `limit` | integer | No | Maximum number of items to return; must be >= 1. |
| `fields` | string | No | Comma-separated list of field names to include in the response. |
| `offset` | integer | No | Zero-based offset for pagination; must be >= 0. |

#### 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 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by any field; prepend '-' for descending order |
| `limit` | integer | No | Maximum number of items to return; must be >= 1 |
| `fields` | string | No | Comma-separated list of field names to include in the response |
| `offset` | integer | No | Zero-based offset for pagination; must be >= 0 |
| `location_id` | string | Yes | ID of the 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 |

### List Voucher Transactions

**Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER`

Tool to list voucher transactions globally across all locations.

#### Input Parameters

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

#### 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 Voucher Transactions by Location

**Slug:** `HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER_BY_LOCATION`

Tool to list voucher transactions by location. Use when you need to retrieve voucher transaction records for a specific location with optional pagination and sorting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Sort by any field; prepend '-' for descending order |
| `limit` | integer | No | Maximum number of items to return; must be >= 1 |
| `fields` | string | No | Comma-separated list of field names to include in the response |
| `offset` | integer | No | Zero-based offset for pagination; must be >= 0 |
| `location_id` | string | Yes | ID of the 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 |

### List Vouchers

**Slug:** `HOTSPOTSYSTEM_VOUCHERS_LIST`

Tool to list the resource owner's vouchers across all locations. Use when you need to retrieve vouchers with optional filtering, sorting, or pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Property name to sort by; prepend '-' for descending order. |
| `limit` | integer | No | Number of items to return per page; must be >= 1. |
| `fields` | string | No | Comma-separated voucher property names to return. |
| `offset` | integer | No | Zero-based page index when paginated by limit; must be >= 0. |

#### 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 |

### Vouchers List by Location

**Slug:** `HOTSPOTSYSTEM_VOUCHERS_LIST_BY_LOCATION`

Retrieves all vouchers associated with a specific location in the HotspotSystem. Use this action to: - List all vouchers available at a particular location - Filter voucher results by specific fields - Sort vouchers by any field (e.g., validity, price) - Implement pagination for large voucher lists Each voucher includes details such as serial number, access code, usage limits (traffic/download/upload), validity period, and pricing information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | 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 | No | Maximum number of vouchers to return per page (minimum 1). Use with offset for pagination. |
| `fields` | string | No | 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 | No | 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 | Yes | The unique identifier of the location. Obtain location IDs using the Locations List action. |

#### 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 |