Skip to navigation

Get Organization Settings

Return the organization’s settings: its name, request tags, payload logging, zero data retention, web search mode, model deprecation handling, and vendor and region restrictions. There’s one per organization.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Response

The organization's settings
auto_handle_model_deprecationsboolean
Move routing policies off deprecated models automatically.
created_atdatetimeRead-only
When the organization was created.
idstringRead-onlyformat: "uuid"
The organization's id.
log_payloadsboolean
Store request and response bodies.
namestring
The organization's name.
slugstringRead-only
Set when the organization is created. It doesn't change.
tag_definitionslist of objects
The request tag keys the organization uses, and the values each allows.
vendor_restrictionsobject
Which vendors and regions requests may use, and whose credentials.
web_search_modeenum

How requests that use a vendor’s built-in web search run: auto uses the vendor’s search where the route can, else Merge’s; merge always uses Merge’s; native only the vendor’s, failing with 400 where the route can’t.

Allowed values:
zero_data_retentionboolean
Route only to vendors that retain no data.

Errors

401
Unauthorized Error
403
Forbidden Error