v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Points Sensors

Retrieve a list of charge points sensors

Required scope: charge-points:read </br>Organization authorization: supported</br></br>Note: Please be aware that this endpoint is currently in the BETA phase

get/api/v1/charge-point-sensors

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

chargePointIdinteger nullable

Allows to filter list of charge points sensors by the charge point id

Example:13

partnerExternalIdstring nullable

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

Example:1

includeDeletedboolean

Filter to include delete resources in the response

Example:true

Response

List of charges point sensors that match the criteria

Example response

{
  "data": [
    {
      "id": 1,
      "type": "occupancy",
      "operatorId": 1,
      "chargePointId": 1,
      "externalId": "SENSOR-10005",
      "partnerExternalId": "ACME-12345",
      "value": "occupied",
      "valueUpdatedAt": "2022-05-12T15:56:45.91Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T16:56:45.99Z",
      "deletedAt": "2022-05-12T16:56:45.99Z"
    }
  ]
}