v1

latestOpenAPI 3.0.0Apache 2.02026-07-1422655.4 KB

Users

Get user

Get details for a user.

get/users/{user_id}

Path parameters

user_idstring string required

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

Headers

Authorizationstring required

access_token passed as "Bearer {access_token}"

Pelm-Client-Idstring required

Pelm-Client-Id given to a developer when they register

Pelm-Secretstring required

Pelm-Secret given to a developer when they register

Response

Successful operation

idstring

This is the id specified by you when you initially created the Connect Token to connect this user's utility account.

utility_usernamestring

credentials_validboolean

Boolean field indicating whether the credentials we have for this User are valid. A common scenario that would cause this field to become false is the 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.

All 22 operations