---
title: "List Vouchers"
method: GET
path: "/v1/sites/{siteId}/hotspot/vouchers"
tags: ["Hotspot"]
---

# List Vouchers

`GET /v1/sites/{siteId}/hotspot/vouchers`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration/v1/sites/{siteId}/hotspot/vouchers`
- 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)

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>

## Path parameters

- `siteId` string, uuid, required

## Query parameters

- `offset` integer
- `limit` integer
- `filter` string

## Response `200`

OK

- HotspotVoucherDetailPage
  - `offset` integer, required
  - `limit` integer, required
  - `count` integer, required
  - `totalCount` integer, required
  - `data` HotspotVoucherDetails[], required
    - `id` string, uuid, required
    - `createdAt` string, date-time, required
    - `name` string, required: Voucher note, may contain duplicate values across multiple vouchers
    - `code` string, required: Secret code to active the voucher using the Hotspot portal
    - `authorizedGuestLimit` integer: (Optional) limit for how many different guests can use the same voucher to authorize network access
    - `authorizedGuestCount` integer, required: For how many guests the voucher has been used to authorize network access
    - `activatedAt` string, date-time: (Optional) timestamp when the voucher has been activated (authorization time of the first guest)
    - `expiresAt` string, date-time: (Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access
    - `expired` boolean, required: Whether the voucher has been expired and can no longer be used to authorize network access
    - `timeLimitMinutes` integer, required: How long (in minutes) the voucher will provide access to the network since authorization of the first guest. Subsequently connected guests, if allowed, will share the same expiration time.
    - `dataUsageLimitMBytes` integer: (Optional) data usage limit in megabytes
    - `rxRateLimitKbps` integer: (Optional) download rate limit in kilobits per second
    - `txRateLimitKbps` integer: (Optional) upload rate limit in kilobits per second

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-network-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-network-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-network-api/revisions/822d5af98ce5?raw)