Retrieve a user

Method

client.users.retrieve(args: GetUserParameters): Promise<GetUserResponse>

string

required

The ID of the user to retrieve.

string

Bearer token for authentication. If not provided, the client-level auth is used.

Returns a User object.

string

Always "user".

string

The ID of the user.

string

Type of the user. Possible values: "person", "bot", "agent".

string | null

The name of the user.

string | null

The avatar URL of the user.

const user = await client.users.retrieve({
  user_id: "user-id-123",
})

console.log(user.name)