API Reference

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get user by user name

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

GET/user/{username}

Get user by user name

ParametersExpand Collapse

username: string

ReturnsExpand Collapse

User { id, email, firstName, 5 more }

id?: number

formatint64

email?: string

firstName?: string

lastName?: string

password?: string

phone?: string

username?: string

userStatus?: number

User Status

formatint32

Get user by user name

TypeScript

HTTP

TypeScript

import RpTestDocs1 from 'rp-test-docs-1';

const client = new RpTestDocs1({
  apiKey: process.env['PETSTORE_API_KEY'], // This is the default and can be omitted
});

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

console.log(user.id);

200 example

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

Returns Examples

200 example

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