Retrieve a list of charge points

get

https://partner-api.monta.com/api/v1/charge-points

Required scope: charge-points:read
Organization authorization: supported

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 0

page number to retrieve (starts with 0)

perPage

int32

Defaults to 10

number of items per page (between 1 and 100, default 10)

siteId

int64 | null

Allows to filter list of charge points by a site id

teamId

int64 | null

Allows to filter list of charge points by a team id

partnerExternalId

string | null

Filter charge points by partnerExternalId, to filter only resources without partnerExternalId use partnerExternalId=""

sortByLocation

string | null

^(-?\d*\.\d+|\d+\.\d*)(,)(-?\d*\.\d+|\d+\.\d*)$

lat,long coordinates. If supplied, the Charge Points will be sorted in nearest first order relativeto this point. (Format: 55.7096,12.5856, -8.050000, -34.900002)

boundingBox

string | null

Bounding box coordinates for filtering. The format should be 'minLat,minLon,maxLat,maxLon'

operatorId

int64 | null

Allows filtering charge point by operatorId.
*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.

includeDeleted

boolean

Defaults to false

Includes deleted resources in the response

includePublic

boolean

Defaults to false

Includes public charge points from other operators in the responseNote: Only supported from Version 2024-07-01

state

string | null

enum

Various types of Charge Point states. Definitions:

available - The charge point is available for charging.
busy - The charge point is currently in use.
busy-blocked - The charge point is currently in use and blocked.
busy-charging - The charge point is currently in use and charging.
busy-non-charging - The charge point is currently in use and not charging.
busy-non-released - The charge point is currently in use and not released.
busy-reserved - The charge point is currently in use and reserved.
busy-scheduled - The charge point is currently in use and scheduled.
error - The charge point is in an error state.
disconnected - The charge point is disconnected from Monta.
passive - The charge point is in a passive state, charging can only be controlled locally.
maintenance - The charge point is in maintenance mode.
exempt - The charge point is exempt from downtime reporting due to external factors.

fromUpdatedDate

date-time | null

Filter to retrieve charge points where updatedAt >= fromUpdatedDate (ISO8601: yyyy-MM-ddTHH:mm:ssZ)

Responses

200List of charges points that match the criteria

400The request is invalid

401Consumer with provided credentials was not found

403Operator doesn't have access to resource

404Entity with the provided id was not found