System Settings

Authentication: All endpoints require an Authorization: Bearer <access token> header.

System settings are platform-wide and are not scoped to a company. Do not send X-Company-ID or X-Location-ID headers for these queries.

See Authentication for details on how to obtain and use access tokens.

Query System Settings

Retrieve all registered system settings. Each entry merges the registry default with any stored override.

Query Parameters:

This query takes no parameters.

Response Fields:

Field Description
key Unique registry key (e.g. mobile:ess:min:version)
type Setting type: BOOLEAN or STRING
value Current value as a string ("true" / "false" for booleans)
label Human-readable label from the registry
updatedAt When the override was last updated, or null if still at default

For the complete SystemSetting type reference and all available fields, see the GraphQL Schema Reference.

Implementation Notes:

  • Only keys defined in the server registry are returned
  • Boolean settings are always returned as the strings "true" or "false"
  • Requires any authenticated user; no special permission is needed to read settings
  • Updating settings is not covered here; use the Roubler admin UI or contact Roubler support

GraphQL Query

query SystemSettings {
  systemSettings {
    key
    type
    value
    label
    updatedAt
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "systemSettings": [
      {
        "key": "mobile:ess:min:version",
        "type": "STRING",
        "value": "4.0",
        "label": "Employee App Min Version",
        "updatedAt": null
      },
      {
        "key": "migration:pre:enabled",
        "type": "BOOLEAN",
        "value": "false",
        "label": "RoublerInt Pre-migration enabled",
        "updatedAt": null
      }
    ]
  }
}

Query System Setting

Retrieve a single registered system setting by key.

Query Parameters:

Parameter Type Required Description
key String! Yes Registry key of the setting

Response Fields:

Field Description
key Unique registry key
type Setting type: BOOLEAN or STRING
value Current value as a string ("true" / "false" for booleans)
label Human-readable label from the registry
updatedAt When the override was last updated, or null if still at default

For the complete SystemSetting type reference and all available fields, see the GraphQL Schema Reference.

Implementation Notes:

  • Returns a client error if key is not registered in the server registry
  • Use systemSettings when you need the full list of available keys and values
  • Requires any authenticated user; no special permission is needed to read settings

GraphQL Query

query SystemSetting($key: String!) {
  systemSetting(key: $key) {
    key
    type
    value
    label
    updatedAt
  }
}

Example Variables

{
  "key": "mobile:ess:min:version"
}

Example Response

{
  "data": {
    "systemSetting": {
      "key": "mobile:ess:min:version",
      "type": "STRING",
      "value": "4.0",
      "label": "Employee App Min Version",
      "updatedAt": null
    }
  }
}