Get a list of vouchers

curl --request GET \
  --url https://api.spirii.com/v2/vouchers

{
  "data": [
    {
      "id": 67890,
      "code": "TT-67890",
      "voucherGroupId": 67890,
      "maxUsers": 100,
      "expiresAt": "2025-06-03T12:00:00.000Z",
      "createdAt": "2025-06-03T12:00:00.000Z",
      "updatedAt": "2025-06-03T12:00:00.000Z",
      "deletedAt": "2025-06-03T12:00:00.000Z"
    }
  ],
  "count": 1
}

Get a list of vouchers

This endpoint allows you to get a paginated list of vouchers. It is possible to set query parameters to filter the results.

A Voucher belongs to a Voucher Group and is uniquely identified by a code. It can be linked to multiple tokens (idtags) and appUsers.

When a driver starts a session at a location, the system checks:

If the driver’s token is linked to a voucher, or

If the driver’s appUser (linked to that token) is linked to a voucher.

If either is true and the voucher’s group is associated with the location, the voucher is applied — potentially affecting pricing or granting access.

GET

vouchers

Get a list of vouchers

curl --request GET \
  --url https://api.spirii.com/v2/vouchers

{
  "data": [
    {
      "id": 67890,
      "code": "TT-67890",
      "voucherGroupId": 67890,
      "maxUsers": 100,
      "expiresAt": "2025-06-03T12:00:00.000Z",
      "createdAt": "2025-06-03T12:00:00.000Z",
      "updatedAt": "2025-06-03T12:00:00.000Z",
      "deletedAt": "2025-06-03T12:00:00.000Z"
    }
  ],
  "count": 1
}

Response

200 - application/json

The returned list of vouchers.

data

object[]

required

A list of Vouchers.

Show child attributes

count

integer

required

Total number of vouchers matching the query.

Required range: x >= 0

Get tokens associated with a voucher by voucher ID

Create a new voucher