getUser()
Retrieves a single User by their ID, if the ID is valid.
function getUser: (userId: string) => Promise<User>;- Name
userId- Type
string- Description
The ID of the user to retrieve.
const userId = 'user_2V7JJKmoA9HqzHhfMqK5cpgLl56';
const response = await clerkClient.users.getUser(userId);
console.log(response);
/*
_User {
id: 'user_2cSSCzV7948rhPJMsY601tXsEU4',
passwordEnabled: true,
totpEnabled: false,
backupCodeEnabled: false,
twoFactorEnabled: false,
banned: false,
createdAt: 1708103362688,
updatedAt: 1708103362701,
imageUrl: 'https://img.clerk.com/eyJ0eXBlIjoiZGVmYXVsdCIsImlpZCI6Imluc18yVjdKRFdyclJwRmZFZTlqQUM2dWpSMG8xSlQiLCJyaWQiOiJ1c2VyXzJjU1NDelY3OTQ4cmhQSk1zWTYwMXRYc0VVNCIsImluaXRpYWxzIjoiVFUifQ',
hasImage: false,
primaryEmailAddressId: 'idn_2cSSCuFhU35F5u5Labwtmj7xU6B',
primaryPhoneNumberId: null,
primaryWeb3WalletId: null,
lastSignInAt: null,
externalId: null,
username: null,
firstName: 'Test',
lastName: 'User',
publicMetadata: {},
privateMetadata: {},
unsafeMetadata: {},
emailAddresses: [
_EmailAddress {
id: 'idn_2cSSCuFhU35F5u5Labwtmj7xU6B',
emailAddress: 'testclerk123@gmail.com',
verification: [_Verification],
linkedTo: []
}
],
phoneNumbers: [],
web3Wallets: [],
externalAccounts: [],
lastActiveAt: null,
createOrganizationEnabled: true
}
*/Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint GET/users/{user_id}. See the BAPI reference for more details.