GET/api/public/configuration

Get the public server configuration

Retrieves the public server configuration, including settings for registration, authentication, billing, and enabled services. Use this endpoint to determine which server capabilities and client-facing settings are available.

5 status codes
200Returns the public configuration object, including registration, authentication, billing, service availability, upload limit, and other client-facing settings.
allowRegistrationsbooleanrequired
appNamestringrequired
authMethodsobjectoptional
authenticationbooleanrequired
billingobjectrequired
capterraTrackerstringoptional
chatwootTokenstringoptional
clientSentryDsnstringoptional
contentDeliveryConfiguredbooleanrequired
ga4Tagstringoptional
intercomAppIdstringoptional
internalControllerEnabledbooleanrequired
llmobjectrequired
machineTranslationServicesobjectrequired
maxTranslationTextLengthintegerrequired
maxUploadFileSizeintegerrequired
nativeEnabledbooleanrequired
needsEmailVerificationbooleanrequired
passwordResettablebooleandeprecatedrequired
Use nativeEnabled instead
plausibleobjectrequired
postHogApiKeystringoptional
postHogHoststringoptional
recaptchaSiteKeystringoptional
screenshotsUrlstringrequired
showVersionbooleanrequired
slackobjectrequired
testClockEnabledbooleanrequired
translationsViewLanguagesLimitintegerrequired
userCanCreateOrganizationsbooleanrequired
versionstringrequired
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when authentication is missing or invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when access to the requested operation is forbidden.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when a requested resource was not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 indicates an invalid request, and a 401 indicates missing or invalid authentication. A 403 indicates forbidden access and a 404 indicates that a requested resource was not found; inspect the error response's code field for the reported reason.