List user rewards

get

https://demo-smartcharging.jedlix.com/api/v2/users/{userId}/rewards

This API endpoint allows you to retrieve rewards for a specific user. The response includes information about the rewards accumulated by the user over a time period, and whether the rewards have already been paid out. You can filter the response by currency using the currency query parameter. Order by the startime of the session most recent reward first.

Path Params

userId

uuid

required

A string value formatted as a Globally Unique Identifier (GUID) that identifies the user whose rewards are being retrieved.

Query Params

startTime

date-time

The start time in UTC of the time period to retrieve payouts for in ISO 8601 UTCdatetime format. If not specified, all rewards will be returned. Optional parameter.

endTime

date-time

The end time in UTC of the time period to retrieve payouts for in ISO 8601 UTC datetime format. If not specified, all rewards will be returned. Optional parameter.

currency

string

An optional ISO 4217 currency code that filters the response to include only rewards in the specified currency.

pageSize

int32

Defaults to 20

The amount of entities returned in the list. Optional parameter, defaults to 20.

pageIndex

int32

Defaults to 1

The page that should be loaded. Optional parameter, defaults to 1

Headers

Jedlix-ClientName

string

Name of the client (or system) calling the api, this is helpful for tracing requests. This is optional.

Jedlix-ClientVersion

string

Version of the client (or system) calling the api, this is helpful for tracing requests. This is optional.

Responses

401

Unauthorized

403

Forbidden

504

Internal api timeout

Language

Credentials

OAuth2

Response

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

application/json

200Success

400Bad Request

404Not Found