Querying users by identity token
Using identity tokens is the recommended way to query user information about authenticated users in your backend. If you need user data about unauthenticated users, you can use the
getUsers
method by passing in a user’s DID.getUser
method to get a single user by their identity token passed from the client, to learn more about identity tokens, see identity tokens.Other ways to query users
Privy rate limits REST API endpoints that you may call from your server. If you’re looking to get
information about an authenticated user, consider using identity
tokens as a more secure and efficient way to access user
data.
Querying users by ID
Use thegetUser
method to get a single user by their Privy DID:Querying for all users
Use thegetUsers
method to get a list of all your users:The
getUsers
method automatically handles pagination and includes built-in exponential backoff to manage rate limits.Querying for users by account data
By email address
By email address
Use the
getUserByEmail
method to get a user by their email address:By phone number
By phone number
Use the
getUserByPhoneNumber
method to get a user by their phone number:By wallet address
By wallet address
Use the
getUserByWalletAddress
method to get a user by their wallet address:By smart wallet address
By smart wallet address
Use the
getUserBySmartWalletAddress
method to get a user by their smart wallet address:By custom auth ID
By custom auth ID
Use the
getUserByCustomAuthId
method to get a user by their custom auth ID:By Farcaster fid
By Farcaster fid
Use the
getUserByFarcasterId
method to get a user by their Farcaster fid:By Twitter subject
By Twitter subject
Use the
getUserByTwitterSubject
method to get a user by their Twitter subject:By Twitter username
By Twitter username
Use the
getUserByTwitterUsername
method to get a user by their Twitter username:By Discord username
By Discord username
Use the
getUserByDiscordUsername
method to get a user by their Discord username:By Telegram User ID
By Telegram User ID
Use the
getUserByTelegramUserId
method to get a user by their Telegram User ID:By Telegram username
By Telegram username
Use the
getUserByTelegramUsername
method to get a user by their Telegram username: