get_comments_from_dsr

Name: get_comments_from_dsr

Description: Returns comments and associated user details for a Digital Sales Room, including thread metadata, authorship, timestamps, and reactions. Use this endpoint to power collaboration surfaces, moderation workflows, and contextual review experiences around shared DSR content.

Schema

{
  "type": "object",
  "properties": {
    "dsrId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      "description": "The unique identifier of the Digital Sales Room; provide the DSR id to target comments or content for that room."
    },
    "systemId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$",
      "description": "The external system identifier that identifies the CRM integration context (for example, the integration name or GUID)."
    }
  },
  "required": [
    "dsrId",
    "systemId"
  ]
}
{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "id property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "userType": {
            "type": "string",
            "description": "",
            "x-enumNames": [
              "Buyer",
              "Seller",
              "Guest"
            ],
            "enum": [
              "Buyer",
              "Seller",
              "Guest"
            ]
          },
          "firstName": {
            "type": "string",
            "description": "firstName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "lastName": {
            "type": "string",
            "description": "lastName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "fullName": {
            "type": "string",
            "description": "fullName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "emailAddress": {
            "type": "string",
            "description": "emailAddress property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "avatarDownloadUrl": {
            "type": "string",
            "description": "avatarDownloadUrl property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "company": {
            "type": "string",
            "description": "company property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "title": {
            "type": "string",
            "description": "title property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "deactivated": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "deactivated property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "organization": {
            "type": "string",
            "description": "organization property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "userName": {
            "type": "string",
            "description": "userName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "deleted": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "deleted property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "languageCode": {
            "type": "string",
            "description": "languageCode property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          },
          "userTimeZoneId": {
            "type": "string",
            "description": "userTimeZoneId property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
          }
        }
      },
      "description": "users property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponseWithUsers."
    },
    "comments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "createdAt property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponse."
          },
          "commentId": {
            "type": "string",
            "format": "guid",
            "description": "commentId property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponse."
          },
          "createdBy": {
            "type": "string",
            "description": "createdBy property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponse."
          },
          "commentBody": {
            "type": "string",
            "description": "commentBody property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponse."
          },
          "reactions": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "userType": {
                  "type": "string",
                  "description": "",
                  "x-enumNames": [
                    "Buyer",
                    "Seller",
                    "Guest"
                  ],
                  "enum": [
                    "Buyer",
                    "Seller",
                    "Guest"
                  ]
                },
                "userId": {
                  "type": "string",
                  "description": "userId property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction."
                },
                "reactionText": {
                  "type": "string",
                  "description": "reactionText property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction."
                },
                "reactionAt": {
                  "type": "string",
                  "format": "date-time",
                  "description": "reactionAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction."
                }
              },
              "description": "AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction schema."
            },
            "description": "reactions property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponse."
          },
          "thread": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "commentId": {
                  "type": "string",
                  "format": "guid",
                  "description": "commentId property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "commentType": {
                  "type": "string",
                  "description": "",
                  "x-enumNames": [
                    "General",
                    "Content",
                    "WelcomeMessage"
                  ],
                  "enum": [
                    "General",
                    "Content",
                    "WelcomeMessage"
                  ]
                },
                "createdUserType": {
                  "type": "string",
                  "description": "",
                  "x-enumNames": [
                    "Buyer",
                    "Seller",
                    "Guest"
                  ],
                  "enum": [
                    "Buyer",
                    "Seller",
                    "Guest"
                  ]
                },
                "createdBy": {
                  "type": "string",
                  "description": "createdBy property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "commentBody": {
                  "type": "string",
                  "description": "commentBody property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "contentId": {
                  "type": "string",
                  "format": "guid",
                  "nullable": true,
                  "description": "contentId property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "isHidden": {
                  "type": "boolean",
                  "description": "isHidden property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "hiddenBy": {
                  "type": "string",
                  "description": "hiddenBy property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "modifiedAt": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true,
                  "description": "modifiedAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "resolvedBy": {
                  "type": "string",
                  "format": "guid",
                  "nullable": true,
                  "description": "resolvedBy property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "resolvedAt": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true,
                  "description": "resolvedAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "deletedBy": {
                  "type": "string",
                  "description": "deletedBy property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "deletedUserType": {
                  "type": "string",
                  "nullable": true,
                  "oneOf": [
                    {
                      "type": "string",
                      "description": "",
                      "x-enumNames": [
                        "Buyer",
                        "Seller",
                        "Guest"
                      ],
                      "enum": [
                        "Buyer",
                        "Seller",
                        "Guest"
                      ]
                    }
                  ],
                  "description": "deletedUserType property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "deletedAt": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true,
                  "description": "deletedAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "description": "createdAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "reactions": {
                  "type": "array",
                  "nullable": true,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "userType": {
                        "type": "string",
                        "description": "",
                        "x-enumNames": [
                          "Buyer",
                          "Seller",
                          "Guest"
                        ],
                        "enum": [
                          "Buyer",
                          "Seller",
                          "Guest"
                        ]
                      },
                      "userId": {
                        "type": "string",
                        "description": "userId property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction."
                      },
                      "reactionText": {
                        "type": "string",
                        "description": "reactionText property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction."
                      },
                      "reactionAt": {
                        "type": "string",
                        "format": "date-time",
                        "description": "reactionAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction."
                      }
                    },
                    "description": "AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentReaction schema."
                  },
                  "description": "reactions property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "latestReplyAt": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true,
                  "description": "latestReplyAt property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "threadSummaries": {
                  "type": "array",
                  "nullable": true,
                  "items": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "id property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "userType": {
                        "type": "string",
                        "description": "",
                        "x-enumNames": [
                          "Buyer",
                          "Seller",
                          "Guest"
                        ],
                        "enum": [
                          "Buyer",
                          "Seller",
                          "Guest"
                        ]
                      },
                      "firstName": {
                        "type": "string",
                        "description": "firstName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "lastName": {
                        "type": "string",
                        "description": "lastName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "fullName": {
                        "type": "string",
                        "description": "fullName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "emailAddress": {
                        "type": "string",
                        "description": "emailAddress property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "avatarDownloadUrl": {
                        "type": "string",
                        "description": "avatarDownloadUrl property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "company": {
                        "type": "string",
                        "description": "company property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "title": {
                        "type": "string",
                        "description": "title property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "deactivated": {
                        "type": "boolean",
                        "nullable": true,
                        "description": "deactivated property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "organization": {
                        "type": "string",
                        "description": "organization property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "userName": {
                        "type": "string",
                        "description": "userName property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "deleted": {
                        "type": "boolean",
                        "nullable": true,
                        "description": "deleted property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "languageCode": {
                        "type": "string",
                        "description": "languageCode property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      },
                      "userTimeZoneId": {
                        "type": "string",
                        "description": "userTimeZoneId property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile."
                      }
                    },
                    "description": "AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsUserProfile schema."
                  },
                  "description": "threadSummaries property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                },
                "thread": {
                  "type": "object",
                  "nullable": true,
                  "description": "thread property of AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse."
                }
              },
              "description": "AgentEcosystemGatewayInfrastructureClientsSeismicBESModelsCommentDataResponse schema."
            },
            "description": "thread property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponse."
          }
        }
      },
      "description": "comments property of AgentEcosystemGatewayAPIDSRCommentsDSRCommentsEndpoint_DSRCommentResponseWithUsers."
    }
  },
  "required": []
}