Provider Settings

Provider settings are configuration definitions owned by one provider—for example an endpoint URL, external account number, or feature flag. They are separate from the platform's tenant Settings API.

How provider settings work

Each setting returns id, name, friendly_name, description, type, options, validation_rules, and value. Supported types are array, string, integer, double, and boolean. In validation_rules, the value entry contains the constraints applied to the supplied value.

Use a stable machine key in name and a tenant-facing label in friendly_name. Provider settings are definitions plus their current values; tenant settings instead expose existing application configuration keys.

GET/api/v1/providers/{provider}/settings

List provider settings

Required scope: providers:read. {provider} accepts the provider group or ID. The default response is a resource collection. Add ?display=minimal to receive a simple {name: value} object.

{
  "endpoint_url": "https://erp.example/api",
  "sync_enabled": true
}

POST/api/v1/providers/{provider}/settings

Create a provider setting

Required scope: providers:write. name, friendly_name, and type are required. description, options, validation_rules, and value are optional.

{
  "name": "endpoint_url",
  "friendly_name": "API endpoint",
  "description": "Base URL of the external system.",
  "type": "string",
  "validation_rules": { "value": ["required", "url"] },
  "value": "https://erp.example/api"
}

PATCH/api/v1/providers/{provider}/settings/{setting}

Update a provider setting

Required scope: providers:write. PUT is also supported. {setting} accepts the setting name or ID.