Skip to main content
GET
Fetches a list of charge boxes

Authorizations

Authorization
string
header
required

Authorization: Bearer <SPIRII_API_KEY>

Query Parameters

nextPageCursor
string

Cursor to be used to request the next page.

Example:

"My0xMDAw"

previousPageCursor
string

Cursor to be used to request the previous page.

Example:

"My0xMDAw"

limit
integer
default:25

Limit amount of returned records.

Required range: 1 <= x <= 100
ids
number[]

List of IDs that uniquely identify the charge boxes

Example:
locationIds
number[]

List of IDs that uniquely identifies the locations

Example:
includeDeletedChargeboxes
boolean
default:false

Whether to include deleted charge boxes in the results.

includeDeletedConnectors
boolean
default:false

Whether to include deleted connectors in the results.

Response

data
object[]
required

List of charge boxes

nextPageCursor
string

Cursor to be used to request the next page.

Example:

"My0xMDAw"

previousPageCursor
string

Cursor to be used to request the previous page.

Example:

"My0xMDAw"