Skip to navigation

Get Root Settings

View as Markdown

Returns application-wide configuration used by the frontend.

Response fields: smsEnabled, smsVerify, emailVerify feature flags; businessName, shortBusinessName; mainWebsite, userDashboardLink, adminDashboardLink; autoDeliveryMax, procurementAutoMax; invoiceFooter; defaultCountry; archiveAfter; termsLink, fraudLink, privacyLink; logoUrl.

Possible errors:

  • 404: Root not found - root configuration document is missing.
  • 404: Warehouse not found - supplied warehouse id does not exist.
  • 400: Missing One or More Required Parameters - required body/query fields were not supplied.
  • 403: Access denied - gateway traffic guard/rate policy blocked the request.
  • 429: Too many requests - gateway rate limit exceeded.
  • 500: Unexpected Error - unhandled gateway or downstream service failure.

Response

OK
key_0integer
key_1string
key_2double
key_3string
key_4boolean

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error