Get Privy users in your app

Gets Users

curl --request GET \
  --url https://api.privy.io/v1/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'privy-app-id: <privy-app-id>'

const options = {
  method: 'GET',
  headers: {'privy-app-id': '<privy-app-id>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://api.privy.io/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.privy.io/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "privy-app-id: <privy-app-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.privy.io/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("privy-app-id", "<privy-app-id>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "did:privy:cm3np4u9j001rc8b73seqmqqk",
      "created_at": 1731974895,
      "linked_accounts": [
        {
          "address": "tom.bombadill@privy.io",
          "type": "email",
          "first_verified_at": 1674788927,
          "latest_verified_at": 1674788927,
          "verified_at": 1674788927
        },
        {
          "type": "farcaster",
          "fid": 4423,
          "owner_address": "0xE6bFb4137F3A8C069F98cc775f324A84FE45FdFF",
          "username": "payton",
          "display_name": "payton ↑",
          "bio": "engineering at /privy. building pixelpool.xyz, the first Farcaster video client. nyc. 👨‍💻🍎🏳️‍🌈  nf.td/payton",
          "profile_picture": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
          "profile_picture_url": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
          "verified_at": 1740678402,
          "first_verified_at": 1740678402,
          "latest_verified_at": 1741194370
        },
        {
          "type": "passkey",
          "credential_id": "Il5vP-3Tm3hNmDVBmDlREgXzIOJnZEaiVnT-XMliXe-BufP9GL1-d3qhozk9IkZwQ_",
          "authenticator_name": "1Password",
          "public_key": "pQECAyYgASFYIKdGwx5XxZ/7CJJzT8d5L6jyLNQdTH7X+rSZdPJ9Ux/QIlggRm4OcJ8F3aB5zYz3T9LxLdDfGpWvYkHgS4A8tPz9CqE=",
          "created_with_browser": "Chrome",
          "created_with_os": "Mac OS",
          "created_with_device": "Macintosh",
          "enrolled_in_mfa": true,
          "verified_at": 1741194420,
          "first_verified_at": 1741194420,
          "latest_verified_at": 1741194420
        }
      ],
      "mfa_methods": [
        {
          "type": "passkey",
          "verified_at": 1741194420
        }
      ],
      "has_accepted_terms": true,
      "is_guest": false
    }
  ],
  "next_cursor": "<string>"
}

GET

users

Gets Users

curl --request GET \
  --url https://api.privy.io/v1/users \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'privy-app-id: <privy-app-id>'

const options = {
  method: 'GET',
  headers: {'privy-app-id': '<privy-app-id>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://api.privy.io/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.privy.io/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "privy-app-id: <privy-app-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.privy.io/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("privy-app-id", "<privy-app-id>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "did:privy:cm3np4u9j001rc8b73seqmqqk",
      "created_at": 1731974895,
      "linked_accounts": [
        {
          "address": "tom.bombadill@privy.io",
          "type": "email",
          "first_verified_at": 1674788927,
          "latest_verified_at": 1674788927,
          "verified_at": 1674788927
        },
        {
          "type": "farcaster",
          "fid": 4423,
          "owner_address": "0xE6bFb4137F3A8C069F98cc775f324A84FE45FdFF",
          "username": "payton",
          "display_name": "payton ↑",
          "bio": "engineering at /privy. building pixelpool.xyz, the first Farcaster video client. nyc. 👨‍💻🍎🏳️‍🌈  nf.td/payton",
          "profile_picture": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
          "profile_picture_url": "https://supercast.mypinata.cloud/ipfs/QmNexfCxdnFzWdJqKVgrjd27UGLMexNaw5FXu1XKR3cQF7?filename=IMG_2799.png",
          "verified_at": 1740678402,
          "first_verified_at": 1740678402,
          "latest_verified_at": 1741194370
        },
        {
          "type": "passkey",
          "credential_id": "Il5vP-3Tm3hNmDVBmDlREgXzIOJnZEaiVnT-XMliXe-BufP9GL1-d3qhozk9IkZwQ_",
          "authenticator_name": "1Password",
          "public_key": "pQECAyYgASFYIKdGwx5XxZ/7CJJzT8d5L6jyLNQdTH7X+rSZdPJ9Ux/QIlggRm4OcJ8F3aB5zYz3T9LxLdDfGpWvYkHgS4A8tPz9CqE=",
          "created_with_browser": "Chrome",
          "created_with_os": "Mac OS",
          "created_with_device": "Macintosh",
          "enrolled_in_mfa": true,
          "verified_at": 1741194420,
          "first_verified_at": 1741194420,
          "latest_verified_at": 1741194420
        }
      ],
      "mfa_methods": [
        {
          "type": "passkey",
          "verified_at": 1741194420
        }
      ],
      "has_accepted_terms": true,
      "is_guest": false
    }
  ],
  "next_cursor": "<string>"
}

SDK methods

Learn more about querying users using our SDKs here.

Authorizations

Authorization

string

header

required

Basic Auth header with your app ID as the username and your app secret as the password.

Headers

privy-app-id

string

required

ID of your Privy app.

Query Parameters

cursor

string

Minimum string length: 1

limit

number | null

Required range: x <= 100

Response

200 - application/json

Requested user objects with pagination.

data

User · object[]

required

Show child attributes

next_cursor

string

Get user by Twitch username Search users

⌘I

API reference

Wallets

Wallet actions

Accounts

Policies

Condition sets

Aggregations

Transactions

Key quorums

Intents

Users

Labs

Get users

SDK methods

Authorizations

Headers

Query Parameters

Response

​SDK methods

Authorizations

Headers

Query Parameters

Response

SDK methods