Skip to main content
GET
Get a list of transactions

Authorizations

Authorization
string
header
required

Authorization: Bearer <SPIRII_API_KEY>

Query Parameters

nextPageCursor
string<<date-time>--<transactionId>>

Cursor to be used to request the next page.

Example:

"2000-01-01T00:00:00.000Z-123456"

previousPageCursor
string<<date-time>--<transactionId>>

Cursor to be used to request the previous page.

Example:

"2000-01-01T00:00:00.000Z-123456"

limit
integer
default:500

Limit returned amount of transactions.

Required range: 1 <= x <= 2500
locationId
integer

Filter by a location ID.

locationType
enum<string>

Filter by a location type.

Available options:
PublicRoad,
Residential,
ParkingLot,
ParkingLotIndoor,
ParkingLotUnderground,
Hotel
transactionType
enum<string>

Filter by a transaction type.

Available options:
roamingEmp,
roamingCpo,
roaming,
nonRoaming
idTagUid
string

Filter by an IdTag unique ID.

appUserId
integer

Filter by an app user ID.

voucherId
integer

Filter by voucher ID.

startedAt
string<date-time>

Filter transactions started from the specified timestamp. When this filter is applied, results are sorted by startedAt in ascending order by default, unless another sortBy parameter is provided.

Example:

"2000-12-01T00:00:00.000Z"

updatedAt
string<date-time>

Filter transactions updated from the specified timestamp. When this filter is applied, results are sorted by updatedAt in ascending order by default, unless another sortBy parameter is provided.

Example:

"2000-12-01T00:00:00.000Z"

updatedAtMax
string<date-time>

Filter transactions up to the specified updated time. When this filter is applied, results are sorted in ascending order by updatedAt by default, unless another sortBy parameter is specified.

Example:

"2000-12-01T00:00:00.000Z"

endedAt
string<date-time>

Filter transactions ended from the specified timestamp. When this filter is applied, results are sorted by endedAt in ascending order by default, unless another sortBy parameter is provided.

Example:

"2000-12-01T00:00:00.000Z"

endedAtMax
string<date-time>

Filter transactions up to the specified end time. When this filter is applied, results are sorted in ascending order by endedAtMax by default, unless another sortBy parameter is specified

Example:

"2000-12-01T00:00:00.000Z"

evseId
string

Filter by an EVSE ID.

chargeBoxId
integer

Filter by an Charge Box ID.

sortBy
enum<string>
default:createdAt

When set, returned transactions will be sorted by one of the available property, descending.

Available options:
createdAt,
startedAt,
updatedAt,
endedAt
ongoing
boolean
default:false

Filter transactions that are still ongoing. A transaction is considered ongoing if it remains incomplete, such as when the electric vehicle is still charging or the cable is still connected.

priority
enum<number>

Retrieve only priority/non-priority transactions

Available options:
0,
1

Response

data
object[]
required
nextPageCursor
string<<date-time>-<uuid>>
Example:

"2000-01-01T00:00:00.000Z-123456"

previousPageCursor
string<<date-time>-<uuid>>
Example:

"2000-01-01T00:00:00.000Z-123456"