Skip to main content
GET
Get the organization settings

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Response

Successful Response

The settings that apply to the whole organization.

default_dbt_targets
string[]
required

The dbt targets that the dbt workload pages filter on by default, usually the production targets.

dbt_meta_keys
string[]
required

The keys in the meta config of dbt resources that SELECT offers for filtering and grouping, for example team or owner.

dbt_top_level_keys
string[]
required

The custom top-level keys in dbt query comments and query tags that SELECT offers for filtering and grouping.

custom_workload_meta_keys
string[]
required

The keys in custom workload metadata that SELECT offers for filtering and grouping.

periscope_account_id
string | null
required

The Periscope account ID: the value after /app/ in a Periscope dashboard URL. Null when not set.

show_incomplete_days
boolean
required

Whether SELECT shows data for the latest day before the data for that day is complete.

show_incomplete_weeks
boolean
required

Whether SELECT shows data for the current week before the week is complete.

show_incomplete_months
boolean
required

Whether SELECT shows data for the current month before the month is complete.

query_sanitization_enabled
boolean
required

Whether SELECT removes string literals, numbers and single-line comments from the query text of every connection. It applies to queries that SELECT syncs after the change. A connection can also turn this on for itself.

hidden_sidebar_workloads
string[]
required

The workload types that SELECT hides from navigation.

disable_user_management
boolean
required

Whether inviting users in SELECT is turned off. SELECT turns this on when the organization adds its first SSO connection, and off when it removes its last one.

home_dashboard_id
string<uuid> | null
required

The ID of the dashboard that SELECT shows as the organization's home page. It must be a public dashboard. Null when not set.

insight_filter_expression
required

The filter that SELECT applies by default when a user first opens the insight pages. A user can remove it for their session. Null means SELECT applies its own default filter.

etag
string
required
read-only

Opaque strong ETag for the settings. Matches the ETag response header, and is what If-Match requires on a write.