Get a list of CDRs

get

https://api.spirii.com/v2/charge-records

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

mode

string

enum

Retrieve CDRs as CPO or EMP. Defaults to CPO. CPO records are all records on your chargers, EMP are all records performed by your Drivers.

Allowed:

string

ongoing

number

enum

Defaults to 0

Retrieve ongoing charging sessions as part of the response.

Allowed:

updatedAtFrom

date-time

Retrieve charge records updated at or after this time.

updatedAtTo

date-time

Retrieve charge records updated before this time.

sortKey

string

Defaults to updatedAt

Field used for sorting the returned results.

sortDirection

string

enum

Defaults to asc

Direction of sorting.

Allowed:

filter

string

Filter object using stringified JSON in MongoDB format. Allowed fields: operatorId, companyId, company.id, auth.idTag.id, auth.idTag.operatorId, auth.idTag.companyId, auth.idTag.customerId, auth.idTag.crmCustomerId, auth.type, transactionId, location.country, location.isPublic, location.crmCustomerId, auth.idTag.uid, startedAt, endedAt, updatedAt, createdAt, isRoaming, location.appUserId, location.id, location.type, consumed, role, evseId, sessionId, paymentMetadata.externalSessionId, roamingDetails.type, voucher.id, chargeBoxId. Mongo operators: $gt, $gte, $lt, $lte, $eq, $ne, $in, $nin, $exists, $regex. Logical operators: $or, $and.

includeChildCompanyRecords

number

enum

Defaults to 0

Retrieve charging sessions belonging to child companies as well, as part of the response.

Allowed:

priority

number

enum

Defaults to 0

Retrieve only priority/non-priority charging records

Allowed:

nextPageCursor

string

Pagination cursor used to traverse returned records forwards when filtering returns more than limit records. This parameter is mutually exclusive with previousPageCursor.

previousPageCursor

string

Pagination cursor used to traverse returned records backwards when filtering returns more than limit records. This parameter is mutually exclusive with nextPageCursor.

limit

integer

Number of records to return.

fields

array of strings

List of CDR's properties to be returned in response.

fields

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization header token is invalid or not provided.

500

Internal Server Error.

200