User

A resource that represents an individual user in the ev.energy system.

idstringuser[A-Z\d]{26}read-onlyrequired

Unique identifier for the given user.

Example:"user01HN2NJ9NMRZBXT1H6FT9N7735"

urlstring, (uri)read-onlyrequired

Example:"https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735"

emailstring, (email)

full_namestringread-only

The user's full name.

Example:"Frodo Baggins"

joined_atstring, (date-time)read-only

The date and time when the user joined the platform.

Example:"2023-06-15T10:00:00Z"

terms_consent_datetimestring or null, (date-time)read-only

When the user gave their terms and conditions consent, or null if they have not.

Example:"2023-06-15T10:00:00Z"

deleted_atstring or null, (date-time)read-only

When the user's account was deleted, or null if it is still live. Deleted accounts are anonymised, so the remaining fields hold placeholder values rather than the user's data. Reaching a deleted user requires include_deleted=true.

Example:"2024-08-01T12:00:00Z"

default_locationLocation (object)

Any of:

Location model for charging locations.

Address validation: Address fields are optional as a group, but each field independently triggers the requirement. If any of address_1, address_2, city, state, postal_code, country_code, or coordinates is provided with a non-null value, then address_1, city, postal_code, and country_code must all be provided as non-null values. Sending the keys with explicit null values is allowed and does not trigger the requirement (this is how addresses are cleared via PATCH). Partial addresses are rejected with a 400.

vehiclesArray of strings, (uri)read-only

Example:

[
  "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
]

evsesArray of strings, (uri)read-only

Example:

[
  "https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"
]

{
  "id": "user01HN2NJ9NMRZBXT1H6FT9N7735",
  "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735",
  "email": "user@example.com",
  "full_name": "Frodo Baggins",
  "joined_at": "2023-06-15T10:00:00Z",
  "terms_consent_datetime": "2023-06-15T10:00:00Z",
  "deleted_at": "2024-08-01T12:00:00Z",
  "default_location": {
    "address_1": "string",
    "address_2": "string",
    "postal_code": "string",
    "country_code": "AD",
    "coordinates": { … },
    "tariff": "https://api.ev.energy/v2/tariffs/tari01HN2NJ9NMRZBXT1H6FT9N7735",
    "city": "string",
    "state": "string",
    "evse_site": "string"
  },
  "vehicles": [
    "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
  ],
  "evses": [
    "https://api.ev.energy/v2/evses/evse01HSH04XHZCT92RN018F0236ZM"
  ]
}