Sign in
Apps

Get app settings

Get the settings and configuration for an app.

get/v1/apps/{app_id}

Path parameters

app_idstring required

The ID of the app.

Headers

privy-app-idstring required

ID of your Privy app.

Response

The app settings.

accent_colorstring nullable required
allowed_domainsstring[] required
allowed_native_app_idsstring[] required
allowed_native_app_url_schemesstring[] required
allowlist_enabledboolean required
apple_oauthboolean required
captcha_enabledboolean required
captcha_site_keystring
custom_api_urlstring nullable required
custom_jwt_authboolean required
data_classification'public' required

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

disable_plus_emailsboolean required
discord_oauthboolean required
email_authboolean required
enabled_captcha_provider'turnstile' | 'hcaptcha' required

The captcha provider enabled for an app.

enforce_wallet_uisboolean required
external_wallets_for_signup_enabledboolean required
farcaster_authboolean required
farcaster_link_wallets_enabledboolean required
fiat_on_ramp_enabledboolean required
github_oauthboolean required
google_oauthboolean required
guest_authboolean required
icon_urlstring nullable required
idstring required
instagram_oauthboolean required
legacy_wallet_ui_configboolean required
line_oauthboolean required
linkedin_oauthboolean required
logo_urlstring nullable required
max_linked_wallets_per_usernumber nullable required
merge_accounts_by_emailboolean required
mfa_methodsMfaMethod[] required
namestring required
passkey_authboolean required
passkeys_for_signup_enabledboolean required
privacy_policy_urlstring nullable required
require_users_accept_termsboolean nullable required
show_wallet_login_firstboolean required
sms_authboolean required
solana_wallet_authboolean required
spotify_oauthboolean required
telegram_authboolean required
telegram_oauthboolean required
terms_and_conditions_urlstring nullable required
themestring required
tiktok_oauthboolean required
twitch_oauthboolean required
twitter_oauthboolean required
twitter_oauth_on_mobile_enabledboolean required
verification_keystring required
wallet_authboolean required
wallet_connect_cloud_project_idstring nullable required
whatsapp_enabledboolean required

Changes

Changed in 4 of the 46 revisions of this API.16

  • 9955c27139f313See the full diff
    • ▲

      the enabled_captcha_provider response's property type/format changed from string null/ to / for status 200

      response-property-type-changed

    • ○

      added CaptchaProvider subschema #2 to the enabled_captcha_provider response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed the hcaptcha enum value from the enabled_captcha_provider response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the turnstile enum value from the enabled_captcha_provider response property for the response status 200

      response-property-enum-value-removed

  • 41cbc1e43b721See the full diff
    • ○

      added the required property external_wallets_for_signup_enabled to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a8d27de9e15d1See the full diff
    • ○

      added the required property merge_accounts_by_email to the response with the 200 status

      response-required-property-added

  • 0cb2f3a660d61See the full diff
    • ○

      added the required property telegram_oauth to the response with the 200 status

      response-required-property-added