Skip to navigation

List conversational processes

View as Markdown
Returns every conversational process in your organization as a JSON array. Unset fields come back as empty values, and secrets come back redacted.

Authentication

AuthorizationBearer

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

Response

The conversational processes in your organization
idstringOptionalRead-only
Unique identifier of the conversational process, assigned by the server. Cannot be changed.
signatureobjectOptional
Name and description of the conversational process. The internal name is derived from the display name. Required.
slotslist of objectsOptional

Input values (slots) the process collects from the user and uses as variables in the conversation flow.

conversation_flowobjectOptional

The control flow of the process, built from sequential, switch, activity, return and no-op blocks. Required.

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
429
Too Many Requests Error
500
Internal Server Error