List Vouchers
Retrieve a paginated list of Hotspot vouchers. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`id`|`UUID`|`eq` `ne` `in` `notIn`| |`createdAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`| |`name`|`STRING`|`eq` `ne` `in` `notIn` `like`| |`code`|`STRING`|`eq` `ne` `in` `notIn`| |`authorizedGuestLimit`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`authorizedGuestCount`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`| |`activatedAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`| |`expiresAt`|`TIMESTAMP`|`eq` `ne` `gt` `ge` `lt` `le`| |`expired`|`BOOLEAN`|`eq` `ne`| |`timeLimitMinutes`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le`| |`dataUsageLimitMBytes`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`rxRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| |`txRateLimitKbps`|`INTEGER`|`isNull` `isNotNull` `eq` `ne` `gt` `ge` `lt` `le`| </details>
Retrieve a paginated list of Hotspot vouchers.
| Name | Type | Allowed functions |
|---|---|---|
id | UUID | eq ne in notIn |
createdAt | TIMESTAMP | eq ne gt ge lt le |
name | STRING | eq ne in notIn like |
code | STRING | eq ne in notIn |
authorizedGuestLimit | INTEGER | isNull isNotNull eq ne gt ge lt le |
authorizedGuestCount | INTEGER | eq ne gt ge lt le |
activatedAt | TIMESTAMP | eq ne gt ge lt le |
expiresAt | TIMESTAMP | eq ne gt ge lt le |
expired | BOOLEAN | eq ne |
timeLimitMinutes | INTEGER | eq ne gt ge lt le |
dataUsageLimitMBytes | INTEGER | isNull isNotNull eq ne gt ge lt le |
rxRateLimitKbps | INTEGER | isNull isNotNull eq ne gt ge lt le |
txRateLimitKbps | INTEGER | isNull isNotNull eq ne gt ge lt le |
Authorization
ApiKey UniFi API key. Create one under Control Plane → Admins & Users → your admin → Create API Key (requires controller 9.0.114+).
In: header
Path Parameters
Query Parameters
Response Body
application/json
curl -X GET "https://example.com/v1/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/hotspot/vouchers"{ "offset": 0, "limit": 25, "count": 10, "totalCount": 1000, "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "createdAt": "2019-08-24T14:15:22Z", "name": "hotel-guest", "code": 4861409510, "authorizedGuestLimit": 1, "authorizedGuestCount": 0, "activatedAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "expired": true, "timeLimitMinutes": 1440, "dataUsageLimitMBytes": 1024, "rxRateLimitKbps": 1000, "txRateLimitKbps": 1000 } ]}