> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siro.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get conversation configurations

> Retrieves conversation configurations for an organization. Users can only access configurations for their own organization unless they are organization admins.



## OpenAPI

````yaml specs/openapi-internalApi.json get /v1/core/conversation-configurations
openapi: 3.0.0
info:
  version: 1.0.0
  title: Swagger API
servers:
  - url: https://api.siro.ai/
    description: Siro API Gateway
security: []
externalDocs:
  description: View the raw OpenAPI Specification in JSON format
  url: /swagger.json
paths:
  /v1/core/conversation-configurations:
    get:
      summary: Get conversation configurations
      description: >-
        Retrieves conversation configurations for an organization. Users can
        only access configurations for their own organization unless they are
        organization admins.
      parameters:
        - schema:
            type: string
            description: The organization ID to get conversation configurations for
          required: true
          description: The organization ID to get conversation configurations for
          name: organizationId
          in: query
      responses:
        '200':
          description: Get conversation configurations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            ID formatted as '${organizationId or
                            teamId}-${conversationType}'
                        conversationType:
                          type: string
                        displayName:
                          type: string
                          description: >-
                            Human-readable name for this conversation
                            configuration
                        orgId:
                          type: string
                        teamId:
                          type: string
                        userId:
                          type: string
                        displayBookmarksInDebrief:
                          type: boolean
                        expressions:
                          type: array
                          items:
                            type: object
                            properties:
                              title:
                                type: string
                                description: >-
                                  Title of bookmarkable expression that will be
                                  displayed in the UI
                              identifiers:
                                type: array
                                items:
                                  nullable: true
                                description: >-
                                  An array of regular expressions that will
                                  trigger this bookmark when found in
                                  conversation text
                              type:
                                type: string
                                enum:
                                  - SECTION
                                  - KEY_WORD
                                  - CLOSE
                                  - SUCCESS
                                  - FAILURE
                                  - FILLER_WORD
                                  - CONVERSATION_BEGIN
                                description: >-
                                  Type of bookmark to create when identifiers
                                  are found (e.g., SECTION, KEY_WORD, CLOSE)
                              overrideParent:
                                type: boolean
                                description: >-
                                  If true, bookmarkable expressions from parent
                                  configuration of the same title and type will
                                  be overridden by, instead of merged with, this
                                  configuration
                              advancedBookmarkModelId:
                                type: string
                                description: >-
                                  DEPRECATED (May 2026): no longer read by the
                                  backend. Retained in the schema for SDK
                                  backwards compatibility.
                              bookmarkConfigId:
                                type: string
                                description: >-
                                  ID of bookmark configuration this expression
                                  belongs to
                            required:
                              - title
                              - identifiers
                              - type
                              - overrideParent
                          description: >-
                            No longer frequently in use. Bookmarkable
                            expressions are used to configure regular
                            expressions that get bookmarked during conversation
                            analysis
                        overrideAllParentExpressions:
                          type: boolean
                          description: >-
                            If true, completely overrides parent configuration
                            expressions instead of merging them
                        debriefQuestions:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              prompt:
                                type: string
                              promptDetails:
                                type: string
                              responseType:
                                type: string
                                enum:
                                  - DATE_RESPONSE
                                  - FREE_TEXT_RESPONSE
                                  - SELECT_RESPONSE
                              responseConfig:
                                anyOf:
                                  - type: object
                                    properties:
                                      latestAllowableDate:
                                        anyOf:
                                          - type: string
                                          - type: number
                                      earliestAllowableDate:
                                        anyOf:
                                          - type: string
                                          - type: number
                                      includeTime:
                                        type: boolean
                                      required:
                                        type: boolean
                                    required:
                                      - includeTime
                                      - required
                                  - type: object
                                    properties:
                                      interpretAsNumber:
                                        type: boolean
                                      required:
                                        type: boolean
                                      maxSize:
                                        type: number
                                      minSize:
                                        type: number
                                      customValidation: {}
                                      validationErrorMessage:
                                        type: string
                                    required:
                                      - interpretAsNumber
                                      - required
                                  - type: object
                                    properties:
                                      options:
                                        type: array
                                        items:
                                          anyOf:
                                            - type: string
                                            - type: number
                                      dropdown:
                                        type: boolean
                                      minSelects:
                                        type: number
                                      maxSelects:
                                        type: number
                                    required:
                                      - options
                              includeIf:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    questionId:
                                      type: string
                                    value:
                                      anyOf:
                                        - type: string
                                        - type: number
                                  required:
                                    - questionId
                                    - value
                              onlyIncludeIfFlagged:
                                type: boolean
                              sortValue:
                                type: number
                              setResponseToField:
                                type: string
                              hideFromResults:
                                type: boolean
                            required:
                              - id
                              - prompt
                              - responseType
                              - responseConfig
                              - sortValue
                          description: >-
                            Questions to ask during the debrief process after a
                            conversation
                        titleQuestionId:
                          type: string
                          description: >-
                            Rarely used. ID of the question that serves as the
                            title for this conversation
                        resultQuestionId:
                          type: string
                          description: >-
                            Rarely used. ID of the question that determines the
                            result/outcome of the conversation
                        tagConfigurations:
                          type: array
                          items:
                            type: object
                            properties:
                              displayName:
                                type: string
                                description: Human-readable name for the tag
                              applyIf:
                                anyOf:
                                  - type: object
                                    properties:
                                      tagExpressionType:
                                        type: string
                                        enum:
                                          - BOOKMARK_TAG_EXPRESSION
                                      bookmarkTitle:
                                        type: string
                                        description: >-
                                          Title of the bookmark to check for in
                                          the conversation
                                      bookmarkType:
                                        type: string
                                        enum:
                                          - SECTION
                                          - KEY_WORD
                                          - CLOSE
                                          - SUCCESS
                                          - FAILURE
                                          - FILLER_WORD
                                          - CONVERSATION_BEGIN
                                        description: >-
                                          Type of bookmark to check for (e.g.,
                                          SECTION, KEY_WORD, CLOSE)
                                      evaluationMethod:
                                        type: string
                                        enum:
                                          - FOUND
                                          - NOT_FOUND
                                        description: >-
                                          Indicates whether the tag being found
                                          should make the expression true.
                                          Defaults to FOUND. Selecting NOT_FOUND
                                          will evaluate to true when the tag is
                                          not found
                                    required:
                                      - tagExpressionType
                                      - bookmarkTitle
                                      - bookmarkType
                                      - evaluationMethod
                                  - type: object
                                    properties:
                                      tagExpressionType:
                                        type: string
                                        enum:
                                          - DEBRIEF_TAG_EXPRESSION
                                      questionId:
                                        type: string
                                      trueIfValueIs:
                                        anyOf:
                                          - type: string
                                          - type: number
                                        description: >-
                                          Value that the question must have for
                                          the expression to be true
                                    required:
                                      - tagExpressionType
                                      - questionId
                                      - trueIfValueIs
                                  - type: object
                                    properties:
                                      tagExpressionType:
                                        type: string
                                        enum:
                                          - JOIN_TAG_EXPRESSION
                                      joinMethod:
                                        type: string
                                        enum:
                                          - OR
                                          - AND
                                        description: >-
                                          Logical operator to combine child
                                          expressions
                                      childExpressions:
                                        type: array
                                        items:
                                          type: object
                                          description: >-
                                            Recursive tag expression that can
                                            contain other expressions
                                          properties:
                                            tagExpressionType:
                                              type: string
                                              description: Type of tag expression
                                          required:
                                            - tagExpressionType
                                        description: Child expressions to combine
                                    required:
                                      - tagExpressionType
                                      - joinMethod
                                      - childExpressions
                                  - type: object
                                    properties:
                                      tagExpressionType:
                                        type: string
                                        enum:
                                          - DURATION_TAG_EXPRESSION
                                      compareToDurationInMilliseconds:
                                        type: number
                                        description: >-
                                          Duration in milliseconds to compare
                                          against
                                      comparisonMethod:
                                        type: string
                                        enum:
                                          - GREATER_THAN
                                          - LESS_THAN
                                        description: How to compare the duration
                                    required:
                                      - tagExpressionType
                                      - compareToDurationInMilliseconds
                                      - comparisonMethod
                                description: >-
                                  Condition that must be met for this tag to be
                                  applied
                            required:
                              - displayName
                              - applyIf
                          description: >-
                            Tags to apply to recordings, if matching criteria
                            are met
                        inheritedBookmarkConfigIds:
                          type: array
                          items:
                            type: string
                          description: >-
                            IDs of bookmark configurations inherited from parent
                            configurations
                        inheritedBookmarkConfigs_denormalized:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              title:
                                type: string
                                description: >-
                                  Human-readable title for the bookmark
                                  configuration
                              description:
                                type: string
                                description: >-
                                  Detailed description of what this bookmark
                                  configuration does
                              bookmarkTypes:
                                type: array
                                items:
                                  type: string
                                  enum:
                                    - SECTION
                                    - KEY_WORD
                                    - BUYING_QUESTION
                                    - COMPETITOR_MENTION
                                    - OBJECTION
                                    - RED_WORD
                                    - SMOKESCREEN
                                    - NEXT_STEPS
                                    - PRICING
                                    - CUSTOMER_PAIN_POINT
                                    - CLOSE
                                    - SUCCESS
                                    - FAILURE
                                    - FILLER_WORD
                                    - CONVERSATION_BEGIN
                                description: >-
                                  Types of bookmarks this configuration can
                                  create
                              manualLabelCount:
                                type: number
                                description: >-
                                  Total number of manual labels for this
                                  bookmark
                              manualLabelCountPositive:
                                type: number
                                description: Number of positive manual labels
                              manualLabelCountNegative:
                                type: number
                                description: Number of negative manual labels
                              modelId:
                                type: string
                                description: >-
                                  ID of the model used for this bookmark
                                  configuration
                              bookmarkGroupIds:
                                type: array
                                items:
                                  type: string
                                description: >-
                                  IDs of bookmark groups this configuration
                                  belongs to
                              lastBackfilledDate:
                                anyOf:
                                  - type: object
                                    properties:
                                      _seconds:
                                        type: number
                                      _nanoseconds:
                                        type: number
                                  - type: string
                                  - nullable: true
                                description: >-
                                  Date when this configuration was last
                                  backfilled with data
                              dateLastUpdated:
                                anyOf:
                                  - type: object
                                    properties:
                                      _seconds:
                                        type: number
                                      _nanoseconds:
                                        type: number
                                  - type: string
                                  - nullable: true
                                description: Date when this configuration was last modified
                              dateCreated:
                                anyOf:
                                  - type: object
                                    properties:
                                      _seconds:
                                        type: number
                                      _nanoseconds:
                                        type: number
                                  - type: string
                                  - nullable: true
                                description: Date when this configuration was created
                              id:
                                type: string
                                description: >-
                                  Unique identifier for this bookmark
                                  configuration
                              llmDescription:
                                type: string
                                description: Description used by LLM for confirmation
                              llmPositiveContext:
                                type: string
                                description: Context provided to LLM for positive examples
                              llmNegativeContext:
                                type: string
                                description: Context provided to LLM for negative examples
                              version:
                                type: number
                                description: DEPRECATED
                              bookmarkType:
                                type: string
                                enum:
                                  - SECTION
                                  - KEY_WORD
                                  - BUYING_QUESTION
                                  - COMPETITOR_MENTION
                                  - OBJECTION
                                  - RED_WORD
                                  - SMOKESCREEN
                                  - NEXT_STEPS
                                  - PRICING
                                  - CUSTOMER_PAIN_POINT
                                  - CLOSE
                                  - SUCCESS
                                  - FAILURE
                                  - FILLER_WORD
                                  - CONVERSATION_BEGIN
                                description: DEPRECATED - use bookmarkTypes instead
                              scope:
                                type: string
                                enum:
                                  - siro
                                  - org
                                description: DEPRECATED
                              model_denormalized:
                                type: object
                                description: DEPRECATED - Use modelId instead
                              belongsToConfigGroups:
                                type: array
                                items:
                                  type: string
                                description: DEPRECATED - Use bookmarkGroupIds instead
                              organizationId:
                                type: string
                                description: DEPRECATED - Use bookmarkGroupIds instead
                            required:
                              - title
                              - description
                              - bookmarkTypes
                              - id
                          description: >-
                            DEPRECATED - do not use. Use
                            inheritedBookmarkConfigIds instead
                        belongsToConfigGroups:
                          type: array
                          items:
                            type: string
                          description: >-
                            Configuration groups this conversation config
                            belongs to
                        checklistId:
                          type: string
                          description: >-
                            DEPRECATED (May 2026): no longer read by the
                            backend. Retained in the schema for SDK backwards
                            compatibility.
                        chatBotKnowledgeBaseIds:
                          type: array
                          items:
                            type: string
                          description: >-
                            Chatbot knowledge base IDs that are used by default
                            for Ask Siro functionality
                        bookmarkGroupIds:
                          type: array
                          items:
                            type: string
                          description: >-
                            IDs of bookmark groups associated with this
                            configuration
                        halftimeModeEnabled:
                          type: boolean
                          description: >-
                            Whether halftime mode is enabled for this
                            conversation configuration.
                        summaryPrompts:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              promptHeader:
                                type: string
                              prompt:
                                type: string
                              promptIndex:
                                type: number
                            required:
                              - id
                              - prompt
                              - promptIndex
                      required:
                        - expressions
                        - debriefQuestions
                        - belongsToConfigGroups
                  cursor:
                    anyOf:
                      - type: string
                      - type: number
                      - nullable: true
                  pageSize:
                    type: number
                  limit:
                    type: number
                  total:
                    type: number
                    nullable: true
                  hasNextPage:
                    type: boolean
                required:
                  - data
        '400':
          description: Bad Request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                required:
                  - error
        '401':
          description: Unauthorized - User not authenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Authentication error message
                required:
                  - error
        '403':
          description: Forbidden - User does not have access
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Authorization error message
                required:
                  - error
        '404':
          description: Not Found - Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Resource not found error message
                required:
                  - error
        '422':
          description: Unprocessable Content - The request failed validation checks
          content:
            application/json:
              schema:
                type: object
                properties:
                  issues:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        expected:
                          type: string
                        received:
                          type: string
                        path:
                          type: array
                          items:
                            anyOf:
                              - type: string
                              - type: number
                        message:
                          type: string
                      required:
                        - code
                        - path
                        - message
                  name:
                    type: string
                    enum:
                      - ZodError
                required:
                  - issues
                  - name
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Internal server error message
                required:
                  - error
      security:
        - SiroAuthToken: []
components:
  securitySchemes:
    SiroAuthToken:
      type: apiKey
      in: header
      name: x-siro-auth-token
      description: >-
        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.
      x-default: <oauth-access-token>

````