Get user by user name

client.users.retrieve(, ?): User { id, email, firstName, 5 more }

get/user/{username}

ParametersExpand Collapse

username: string

ReturnsExpand Collapse

User { id, email, firstName, 5 more }

id?: number

email?: string

firstName?: string

lastName?: string

password?: string

phone?: string

username?: string

userStatus?: number

User Status

formatint32

Get user by user name

import ArenaDemoDayDemoDocsDemoSite from 'arena-demo-day-demo-docs-demo-site-and-typescript-library';

const client = new ArenaDemoDayDemoDocsDemoSite({
  apiKey: 'My API Key',
});

const user = await client.users.retrieve('username');

console.log(user.id);

{
  "id": 10,
  "email": "john@email.com",
  "firstName": "John",
  "lastName": "James",
  "password": "12345",
  "phone": "12345",
  "username": "theUser",
  "userStatus": 1
}

Returns Examples

{
  "id": 10,
  "email": "john@email.com",
  "firstName": "John",
  "lastName": "James",
  "password": "12345",
  "phone": "12345",
  "username": "theUser",
  "userStatus": 1
}