Skip to main content

Show Setting

GET 

/api/v2/settings/:slug

Returns a single settings group by slug as a flat JSON object of its fields.

Required scope: settings:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Slug general includes (among others):

  • connectivity_alert_sound_enabled (boolean, default false) — play a repeating audio alert on the device when the app loses connection to the server, and a confirmation tone when restored.
  • stranded_order_minimum_age_days (integer, default 3) — whole business days (Mon-Fri) an order must go without producing a fulfillment order before the "Stuck, Never Dispatched" dashboard tile counts it as stranded. Auto-dispatch runs from a queue, so a just-placed order is legitimately undispatched for a short while. 0 disables the floor.

Authentication: Requires Bearer token.

Request

Responses

OK