Get a list of tokens

get

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

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

In EV charging systems, tokens (also known as ID tags or charge keys) are unique identifiers that authenticate users to initiate a charging session. Spirii differentiates between three different types of tokens:

RFIDs represent a physical identifier with a MiFare chip that can be read by chargers.
Virtual tokens represent a digital identifier for authentication through the Spirii app (or a branded app)
Vehicle tokens (also known as “Autocharge”) represent the vehicle's MAC address or VIN code that when registered in Spirii’s platform. They allow a charger to recognize a vehicle and authorize charging when a vehicle is plugged in.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

length ≤ 50

Search for tokens by tokenId, label or uid.

type

string

enum

Filter by token type.

Allowed:

customerId

integer

≥ 1

Filter by a specific customer ID.

isActive

boolean

Filter by active or inactive tokens.

roamingEnabled

boolean

Filter by roaming enabled or disabled.

priority

boolean

Retrieve only priority/non-priority tokens.

validFrom

date-time

Filter for tokens valid from the specified timestamp.

expiresFrom

date-time

Filter for tokens expiring from the specified timestamp.

sortBy

string

enum

Defaults to id

When set, returned tokens will be sorted by one of the available properties.

Allowed:

sortDirection

string

enum

Defaults to desc

Set the direction of sorting.

Allowed:

offset

number

≥ 0

Defaults to 0

Skip the first N items in the result set.

limit

number

1 to 1000

Defaults to 500

Limit the returned amount of tokens.

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization header JWT token is invalid or not provided.

500

Internal Server Error.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The returned list of tokens.