GET
/
users
/
{user_id}
curl --request GET \
     --url https://api.pelm.com/users/user_id \
     --header 'accept: application/json'
  {
      "id": "72be9d5c-f7c7-4d53-bafc-8846232ee02b",
      "utility": {
        "id": 1,
        "full_name": "Pacific Gas & Electricity"
      },
      "utility_username": "[email protected]",
      "credentials_valid": true
  }

Path Params

user_id
string
required

user_id for the user that you submitted when you first created a Connect Token for this user

Headers

Authorization
string
required

access_token passed as “Bearer {access_token}”

Pelm-Client-Id
string
required

Pelm-Client-Id given on registration

Pelm-Secret
string
required

Pelm-Secret given on registration

Response

id
string

The id you specified when you initially created the Connect Token to connect this user’s utility account

utility
object
utility_username
string

The id you specified when you initially created the Connect Token to connect this user’s utility account

credentials_valid
boolean

A boolean field indicating whether the credentials we have for this User are valid

A common scenario that would cause this field to be false is your user changing their password. If this field is false, then we’re unable to pull the latest data for this User and your user needs to go through the Connect flow again.