Skip to main content
GET
Get active permits

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

Permit ID

retailer_pk
number
required

Retailer ID

Response

200 - application/json

OK

id
integer
read-only

Permit ID

Example:

10004

retailer
object
variant
object
connection
object
retailer_price
string<decimal> | null

Retailer price

Example:

"12.99"

retailer_cost
string<decimal> | null

Retailer cost

Example:

"8.99"

pricing
object
attributes
object
start_at
string<date-time> | null

Time of permit beginning

Example:

"2021-07-10T15:24:56Z"

end_at
string<date-time> | null

Time of permit ending

Example:

"2022-11-10T15:24:56Z"

is_in_effect
boolean
read-only

true: Permit is in effect
false: Permit is not in effect

Example:

true

revoked_at
string<date-time> | null

Time of when permit got revoked

Example:

"2022-08-10T15:24:56Z"

is_acknowledged
boolean
read-only

true: Permit is acknowledged
false: Permit is not acknowledged

Example:

true

acknowledged_at
string<date-time> | null

Time of permit acknowledgement (UTC format)

Example:

"2022-08-10T15:24:56Z"