Querying users
Privy supports multiple ways to fetch and manage users in your application.
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.
Use the 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 the getUser method to get a single user by their Privy DID:
Querying for all users
Use the getUsers 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
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.
Use the 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 the getUser method to get a single user by their Privy DID:
Querying for all users
Use the getUsers 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
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 get method by passing in a user’s DID.
Use the get_by_id_token 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 the get method to get a single user by their Privy DID:
Querying for all users
Use the list method to get a list of all your users:
The list method automatically handles pagination.
Querying for users by account data
Querying users by ID
To get a user by their Privy DID, make a GET request to:
Parameters
The user’s Privy DID (e.g., did:privy:XXXXXX).
Sample request
Querying for all users
To get all users for your app, make a GET request to:
Parameters
Cursor for pagination. Use the next_cursor from the previous response.
Number of users to return per request. Defaults to 100.
Response
The response will include:
data: Array of user objectsnext_cursor: Cursor to use for the next batch of users