Hotspot

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>

get/v1/sites/{siteId}/hotspot/vouchers

Request

Base URL
https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration
Auth
none declared
TypeScript
https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/:siteId/hotspot/vouchers/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

siteIdstring uuid required

Query parameters

offsetinteger

limitinteger

filterstring

Response

offsetinteger required

limitinteger required

countinteger required

totalCountinteger required

Example response

{
  "limit": 25,
  "count": 10,
  "totalCount": 1000,
  "data": [
    {
      "name": "hotel-guest",
      "authorizedGuestLimit": 1,
      "timeLimitMinutes": 1440,
      "dataUsageLimitMBytes": 1024,
      "rxRateLimitKbps": 1000,
      "txRateLimitKbps": 1000
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.