Skip to main content
GET
/
v1
/
core
/
conversation-configurations
Get conversation configurations
curl --request GET \
  --url https://api.siro.ai/v1/core/conversation-configurations \
  --header 'x-siro-auth-token: <api-key>'
{
  "data": [
    {
      "expressions": [
        {
          "title": "<string>",
          "identifiers": [
            null
          ],
          "overrideParent": true,
          "advancedBookmarkModelId": "<string>",
          "bookmarkConfigId": "<string>"
        }
      ],
      "debriefQuestions": [
        {
          "id": "<string>",
          "prompt": "<string>",
          "responseConfig": {
            "includeTime": true,
            "required": true,
            "latestAllowableDate": "<string>",
            "earliestAllowableDate": "<string>"
          },
          "sortValue": 123,
          "promptDetails": "<string>",
          "includeIf": [
            {
              "questionId": "<string>",
              "value": "<string>"
            }
          ],
          "onlyIncludeIfFlagged": true,
          "setResponseToField": "<string>",
          "hideFromResults": true
        }
      ],
      "belongsToConfigGroups": [
        "<string>"
      ],
      "id": "<string>",
      "conversationType": "<string>",
      "displayName": "<string>",
      "orgId": "<string>",
      "teamId": "<string>",
      "userId": "<string>",
      "displayBookmarksInDebrief": true,
      "overrideAllParentExpressions": true,
      "titleQuestionId": "<string>",
      "resultQuestionId": "<string>",
      "tagConfigurations": [
        {
          "displayName": "<string>",
          "applyIf": {
            "bookmarkTitle": "<string>"
          }
        }
      ],
      "inheritedBookmarkConfigIds": [
        "<string>"
      ],
      "inheritedBookmarkConfigs_denormalized": {},
      "checklistId": "<string>",
      "chatBotKnowledgeBaseIds": [
        "<string>"
      ],
      "bookmarkGroupIds": [
        "<string>"
      ],
      "halftimeModeEnabled": true,
      "summaryPrompts": [
        {
          "id": "<string>",
          "prompt": "<string>",
          "promptIndex": 123,
          "promptHeader": "<string>"
        }
      ]
    }
  ],
  "cursor": "<string>",
  "pageSize": 123,
  "limit": 123,
  "total": 123,
  "hasNextPage": true
}

Authorizations

x-siro-auth-token
string
header
default:<oauth-access-token>
required

OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header x-siro-auth-token: <oauth-access-token>. Not an organization API key.

Query Parameters

organizationId
string
required

The organization ID to get conversation configurations for

Response

Get conversation configurations

data
object[]
required
cursor
pageSize
number
limit
number
total
number | null
hasNextPage
boolean