Apps

Get app settings

Changed on

Get the settings and configuration for an app.

get/v1/apps/{app_id}

Request

  • Base URL
    https://api.privy.io
  • URL
    https://api.privy.io/v1/apps/{app_id}
  • Auth
    HTTP basic

Path parameters

app_idstring required

The ID of the app.

Headers

privy-app-idstring required

ID of your Privy app.

Response

The app settings.

idstring required
namestring required
legal_namestring nullable required

The legal name of the company that operates the app.

logo_urlstring nullable required
icon_urlstring nullable required
terms_and_conditions_urlstring nullable required
privacy_policy_urlstring nullable required
require_users_accept_termsboolean nullable required
themestring required
accent_colorstring nullable required
show_wallet_login_firstboolean required
allowed_domainsstring[] required
allowed_native_app_idsstring[] required
allowed_native_app_url_schemesstring[] required
wallet_authboolean required
email_authboolean required
sms_authboolean required
google_oauthboolean required
twitter_oauthboolean required
discord_oauthboolean required
github_oauthboolean required
spotify_oauthboolean required
instagram_oauthboolean required
tiktok_oauthboolean required
line_oauthboolean required
twitch_oauthboolean required
linkedin_oauthboolean required
apple_oauthboolean required
telegram_oauthboolean required
farcaster_authboolean required
passkey_authboolean required
passkeys_for_signup_enabledboolean required
telegram_authboolean required
telegram_seamless_auth_enabledboolean
guest_authboolean required
solana_wallet_authboolean required
external_wallets_for_signup_enabledboolean required
custom_jwt_authboolean required
disable_plus_emailsboolean required
merge_accounts_by_emailboolean required
allowlist_enabledboolean required
wallet_connect_cloud_project_idstring nullable required
custom_api_urlstring nullable required
enforce_wallet_uisboolean required
legacy_wallet_ui_configboolean required
fiat_on_ramp_enabledboolean required
captcha_enabledboolean required
enabled_captcha_provider'turnstile' | 'hcaptcha' required

The captcha provider enabled for an app.

twitter_oauth_on_mobile_enabledboolean required
mfa_methodsMfaMethod[] required
captcha_site_keystring
verification_keystring required
max_linked_wallets_per_usernumber nullable required
farcaster_link_wallets_enabledboolean required
whatsapp_enabledboolean required
data_classification'public' required

Indicates that this response contains only publicly accessible data, not a privileged resource

Changes

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • warning

      added the new email enum value to the / response property for the response status