Skip to navigation

Get native plugin settings

View as Markdown

Returns your organization’s native plugin settings. There is one per organization, so there is no id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Response

Your organization's native plugin settings
searchobjectOptional
Settings for search plugins, such as forms, rooms, people and enterprise search.
user_preferencesobjectOptional
Settings for user preference plugins, such as changing the response language.
ticketingobjectOptional
Settings for ticketing plugins, such as viewing, resolving, reopening and commenting on tickets.
access_provisioningobjectOptional
Settings for access provisioning plugins, such as distribution list management and software access.
access_accountobjectOptional
Settings for account access plugins, such as unlocking accounts and resetting passwords or MFA.
approvalsobjectOptional
Settings for approvals plugins, such as viewing, listing and acting on approval records.
llm_passthroughobjectOptional
Settings for general writing plugins, such as writing emails and translating text.
smart_handoffobjectOptional
Settings for the smart handoff plugin.
gptobjectOptional
Settings for generative AI plugins, such as QuickGPT and world knowledge web search.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error