Get a list of transactions

get

https://api.spirii.com/v2/transactions

Returns a list of Transactions. It is possible to set query parameters to filter the results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nextPageCursor

string

Cursor to be used to request the next page.

previousPageCursor

string

Cursor to be used to request the previous page.

limit

integer

1 to 2500

Defaults to 500

Limit returned amount of transactions.

locationId

integer

Filter by a location ID.

locationType

string

enum

Filter by a location type.

Allowed:

transactionType

string

enum

Filter by a transaction type.

Allowed:

idTagUid

string

Filter by an IdTag unique ID.

appUserId

integer

Filter by an app user ID.

voucherId

integer

Filter by voucher ID.

startedAt

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.

updatedAt

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.

updatedAtMax

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.

endedAt

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.

endedAtMax

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

evseId

string

Filter by an EVSE ID.

chargeBoxId

integer

Filter by an Charge Box ID.

sortBy

string

enum

Defaults to createdAt

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

Allowed:

ongoing

boolean

Defaults to 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

number

enum

Retrieve only priority/non-priority transactions

Allowed:

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization Spirii API Key invalid or not provided.

502

Bad Gateway response.

200