---
title: "Fetch Tenants"
method: GET
path: "/v1/tenants"
tags: ["Tenant Management"]
---

# Fetch Tenants

`GET /v1/tenants`

## Query parameters

- `select` string

## Response `200`

Successful Response

- TenantOut[]
  - `id` string, nullable
  - `name` string, nullable
  - `title` string, nullable
  - `description` string, nullable
  - `created_on` string, date-time, nullable
  - `created_by` string, nullable
  - `created_by_username` string, nullable
  - `updated_at` string, date-time, nullable
  - `tags` string[], nullable
  - `settings` SettingsOutput
    - `model_settings` ModelSettingsOutput
      - `base_llm` BaseLLMSettingsOutput
        - `model_name` string, nullable — Name of the model to use as the base LLM. Must be a valid model name available on watsonx.ai.
        - `model_id` union — The ID of a custom configured model to use as the base LLM model used by Orchestrate.
          - string
          - string, uuid
        - `model_params` object, nullable — Default models params to use.
        - `guardrails` GuardrailsOutput
          - `hap` Guardrail
            - `input` GuardrailConfig
              - …
            - `output` GuardrailConfig
              - …
            - `mask` MaskProperties
              - …
          - `social_bias` Guardrail
            - `input` GuardrailConfig
              - …
            - `output` GuardrailConfig
              - …
            - `mask` MaskProperties
              - …
          - `pii` Guardrail
            - `input` GuardrailConfig
              - …
            - `output` GuardrailConfig
              - …
            - `mask` MaskProperties
              - …
        - `system_prompt` string, nullable — Override the system prompt used by the Orchestrate base LLM.
      - `embeddings` EmbeddingsModelSettings
        - `model_name` string, nullable — Name of the model to use for embeddings. Must be a valid model name available on watsonx.ai.
        - `model_id` union — The ID of a custom configured model to use for embeddings.
          - string
          - string, uuid
      - `is_base_llm_enabled` boolean — The is_base_llm_enabled flag is used to switch the route between LLM`s. By default the value for the flag will be False
    - `router_settings` RouterSettings
      - `router_type` string
      - `model_name` string, nullable — Name of the model to use for routing. Must be a valid model name available on watsonx.ai.
      - `model_id` union — The ID of a custom configured model to use for routing.
        - string
        - string, uuid
      - `model_params` object, nullable — Default models params to use.
      - `routing_prompt` string, nullable — Override the routing prompt used by the Orchestrate routing LLM.
      - `router_config` RouterConfig
        - `continue_journey_on_none` boolean
        - `confidence_threshold` number, nullable
        - `confidence_method` string
    - `user_settings` UserSettings
      - `confirm_routing` boolean — Should Orchestrate confirm routing decisions explicity with the user. Enabled by default.
      - `clear_watsonx_assistant_context` boolean — If set to `True` AND the last turn event was from a Dialog Assistant where `branch_exited` was set to `True` and `branch_completion_reason` is `completed`, then the prior context is cleared
      - `clientside_shortlisting` boolean — if clientside shortlisting is enabled, we would expect custom_routing_table in the message. Default to False.
    - `slot_filling_settings` SlotFillerSettings
      - `slot_filler_type` string
      - `model_name` string, nullable — Name of the model to use for slot filling. Must be a valid model name available on watsonx.ai.
      - `model_id` union — The ID of a custom configured model to use for slot filling.
        - string
        - string, uuid
      - `model_params` object, nullable — Default models params to use.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/ibm/apis/wxo-server-api.md) · [All operations](https://skmtc.net/ibm/apis/wxo-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibm/wxo-server-api/revisions/82c114c37196/schema)