Skip to main content
GET
Get admin use cases (FULL or MINIMAL)

Authorizations

Authorization
string
header
required

Bearer token authentication. Format: 'Bearer '

Query Parameters

response_type
enum<string>
default:FULL
Available options:
FULL,
MINIMAL
use_case_ids
string[] | null

Response

Successful Response

Response schema for use case data involved in the GET use_cases request.

id
string
required
label
MultilingualText · object
required

Pydantic model for a multilingual text.

description
MultilingualText · object
required

Pydantic model for a multilingual text.

deleted
boolean
default:false
disclaimer
Disclaimer · object | null
show_to_unauthorized_users
boolean | null
default:false
can_contain_personal_knowledge_assets
boolean | null
default:false
knowledge_asset_ids
string[] | null
knowledge_source_ids
string[] | null
org_entity_ids
string[]
quick_action_ids
string[]
query_splitting
boolean | null
show_knowledge_assets
boolean | null
default:true
enable_additional_questions
boolean
default:true
guided_search_field_ids
string[]
glossary_id
string | null
enable_targeted_web_search
boolean | null
feedback_form_config
Feedback Form Config · object | null
privacy_policy
PrivacyPolicy · object | null
allow_url_retrieval_from_prompt
boolean | null
default:false
is_personal_space
boolean | null
default:false
enable_file_upload
boolean | null
default:false
disable_reranking
boolean | null
default:false
enable_pro_search
boolean | null
default:false
support_email
string | null
context_about_users
string | null
context_about_company
string | null
context_about_documents
string | null
tonality
string | null
sync_connectors
enum<string>[]
Available options:
confluence,
disa,
google_drive,
google_oauth,
jira,
one_losp,
sap_btp,
servicenow,
sharepoint,
still_sales_and_service,
smtp,
cloud_storage,
manually_synced
credential_ids
string[]
sync_connectors_enabled_user_credentials
enum<string>[]
Available options:
confluence,
disa,
google_drive,
google_oauth,
jira,
one_losp,
sap_btp,
servicenow,
sharepoint,
still_sales_and_service,
smtp,
cloud_storage,
manually_synced
qr_code_access_enabled
boolean
default:false