GET /api/v2/environment/ – KoboToolbox Primary API

Configuration

Retrieve Kobo server environment configurations.

This endpoint provides a wide range of configuration details required by the frontend client, including:

Legal, support, and community URLs (e.g. Terms of Service, Privacy Policy).
Frontend configuration (retry times, usage limit enforcement, etc).
Global static lists (sectors, countries, interface languages, operational purposes).
Metadata configuration (available project and user metadata fields).
Features configurations (MFA, password entropy meter, custom guidance text).
Sign-in and account creation branding (theme, logos, background and supporting image, supporting text) and behaviour (whether registration is open, whether a username is accepted at sign-in).
Additional integrations and features (Stripe public key, ASR & MT enablement, Social apps).

get/api/v2/environment/

Request

registration_openboolean required

Whether users may create their own accounts

terms_of_service_urlstring nullable required

privacy_policy_urlstring nullable required

source_code_urlstring nullable required

support_emailstring nullable required

support_urlstring nullable required

academy_urlstring nullable required

community_urlstring nullable required

frontend_min_retry_timeinteger required

frontend_max_retry_timeinteger required

use_team_labelboolean required

usage_limit_enforcementboolean required

allow_self_account_deletionboolean required

project_history_log_lifespaninteger required

mfa_localized_help_textstring required

Markdown string for MFA help text

mfa_enabledboolean required

mfa_code_lengthinteger required

superuser_auth_enforcementboolean required

enable_password_entropy_meterboolean required

enable_custom_password_guidance_textboolean required

custom_password_localized_help_textstring required

Markdown string for custom password help text

asr_mt_features_enabledboolean required

Whether ASR and MT features are enabled for the current user

submission_placeholderstring required

Placeholder text for submissions

stripe_public_keystring nullable required

terms_of_service__sitewidemessage__existsboolean required

Indicates if a sitewide message for TOS exists

open_rosa_serverstring uri required

The OpenRosa server URL (KC)