Skip to main content
GET
/
voucher-groups
/
{id}
Retrieve all information about a specific Voucher Group
curl --request GET \
  --url https://api.spirii.com/voucher-groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 24,
  "name": "AKB2022",
  "perKwh": 2.5,
  "currency": "DKK",
  "isSpotPriceBased": false,
  "spotPriceMargin": null,
  "spotPriceMarginPct": null,
  "spotPriceMinimum": 0.5,
  "createdAt": "2021-01-07T08:21:43.000Z",
  "updatedAt": "2022-11-07T04:56:18.000Z",
  "voucherCount": 1,
  "locations": [
    {
      "id": 1145,
      "name": "TheVillage",
      "streetAddress": "Lenin",
      "zipCode": "640022",
      "city": "Kurgan"
    }
  ],
  "vouchers": [
    {
      "id": 1020,
      "code": "AKB2021",
      "maxUsers": null,
      "users": [
        26149,
        3979,
        15513,
        null,
        18110,
        3952,
        31525,
        4209,
        16284,
        2320
      ],
      "expiresAt": null,
      "createdAt": "2021-01-07T08:21:43.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

Voucher group id

Example:

1

Response

Voucher Group

​
id
integer
required

id

Example:

1

​
name
string
required

name

Example:

"Kokbjerg"

​
perKwh
number | null
required

price per kwh

Example:

3

​
currency
string | null
required

pricing currency

Example:

"DKK"

​
isSpotPriceBased
boolean
required
Example:

false

​
spotPriceMargin
number | null
required
Example:

0.5

​
spotPriceMarginPct
number | null
required
Example:

0.5

​
spotPriceMinimum
number | null
required
Example:

0.5

​
createdAt
string<timestamp>
required

Created date

Example:

"2021-04-20T14:38:20.000Z"

​
updatedAt
string<timestamp>
required

Updated date

Example:

"2021-04-20T14:38:20.000Z"

​
voucherCount
integer
required
Example:

1

​
location
object
​
voucher
object