GET api/NE/Conversations
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of Conversation| Name | Description | Type | Additional information | 
|---|---|---|---|
| ConversationCategoryId | integer | 
                             None.  | 
                |
| ConversationId | integer | 
                             None.  | 
                |
| ConversationResponseTypeId | byte | 
                             None.  | 
                |
| ConversationStatusId | byte | 
                             None.  | 
                |
| ConversationTypeId | byte | 
                             None.  | 
                |
| CreatedBy | integer | 
                             None.  | 
                |
| CreatedDate | date | 
                             None.  | 
                |
| ModifiedBy | integer | 
                             None.  | 
                |
| ModifiedDate | date | 
                             None.  | 
                |
| OtherDescription | string | 
                             None.  | 
                |
| WithEntityId | integer | 
                             None.  | 
                |
| WithEntityNameId | integer | 
                             None.  | 
                |
| DisplayName | string | 
                             None.  | 
                |
| ConversationConversationActions | Collection of ConversationConversationAction | 
                             None.  | 
                |
| ConversationEntities | Collection of ConversationEntity | 
                             None.  | 
                |
| Messages | Collection of Message | 
                             None.  | 
                |
| ConversationCategory | ConversationCategory | 
                             None.  | 
                |
| ConversationResponseType | ConversationResponseType | 
                             None.  | 
                |
| ConversationStatus | ConversationStatus | 
                             None.  | 
                |
| ConversationType | ConversationType | 
                             None.  | 
                |
| CreatedByUser | User | 
                             None.  | 
                |
| ModifiedByUser | User | 
                             None.  | 
                
Response Formats
application/json, text/json
            Sample:
[
  {
    "$id": "1",
    "$type": "NE.Entities.Server.HT.Conversation, NE.Entities.Server",
    "ConversationCategoryId": 1,
    "ConversationId": 2,
    "ConversationResponseTypeId": 64,
    "ConversationStatusId": 64,
    "ConversationTypeId": 64,
    "CreatedBy": 6,
    "CreatedDate": "2025-11-04T01:22:58.688+00:00",
    "ModifiedBy": 1,
    "ModifiedDate": "2025-11-04T01:22:58.688+00:00",
    "OtherDescription": "sample string 8",
    "WithEntityId": 9,
    "WithEntityNameId": 10,
    "DisplayName": "sample string 11",
    "ConversationConversationActions": [
      {
        "$id": "2",
        "$type": "NE.Entities.Server.HT.ConversationConversationAction, NE.Entities.Server",
        "ConversationActionId": 1,
        "ConversationConversationActionId": 2,
        "ConversationId": 3,
        "EntityId": 1,
        "EntityNameId": 1,
        "Conversation": {
          "$ref": "1"
        },
        "ConversationAction": {
          "$id": "3",
          "$type": "NE.Entities.Server.HT.ConversationAction, NE.Entities.Server",
          "CodeName": "sample string 1",
          "ConversationActionCategoryId": 64,
          "ConversationActionId": 3,
          "Description": "sample string 4",
          "ConversationConversationActions": [
            {
              "$ref": "2"
            },
            {
              "$ref": "2"
            }
          ],
          "ConversationActionCategory": {
            "$id": "4",
            "$type": "NE.Entities.Server.HT.ConversationActionCategory, NE.Entities.Server",
            "CodeName": "sample string 1",
            "ConversationActionCategoryId": 64,
            "Description": "sample string 3",
            "ConversationActions": [
              {
                "$ref": "3"
              },
              {
                "$ref": "3"
              }
            ]
          }
        },
        "EntityName": {
          "$id": "5",
          "$type": "AHS.Server.Entities.EntityName, AHS.Server",
          "EntityNameId": 1,
          "Description": "sample string 2",
          "CodeName": "sample string 3"
        }
      },
      {
        "$ref": "2"
      }
    ],
    "ConversationEntities": [
      {
        "$id": "6",
        "$type": "NE.Entities.Server.HT.ConversationEntity, NE.Entities.Server",
        "ConversationEntityId": 1,
        "ConversationId": 2,
        "EntityId": 3,
        "EntityNameId": 64,
        "Conversation": {
          "$ref": "1"
        }
      },
      {
        "$ref": "6"
      }
    ],
    "Messages": [
      {
        "$id": "7",
        "$type": "NE.Entities.Server.HT.Message, NE.Entities.Server",
        "ConversationId": 1,
        "CreatedBy": 2,
        "CreatedDate": "2025-11-04T01:22:58.688+00:00",
        "IsDeleted": true,
        "MessageId": 5,
        "ModifiedBy": 1,
        "ModifiedDate": "2025-11-04T01:22:58.688+00:00",
        "DisplayName": "sample string 6",
        "ReadDate": "2025-11-04T01:22:58.688+00:00",
        "SenderEntityId": 7,
        "SenderEntityNameId": 8,
        "Text": "sample string 9",
        "Conversation": {
          "$ref": "1"
        },
        "CreatedByUser": {
          "$id": "8",
          "$type": "AHS.Server.Entities.User, AHS.Server",
          "UserId": 1,
          "Username": "sample string 2",
          "FirstName": "sample string 3",
          "LastName": "sample string 4",
          "Email": "sample string 5",
          "IsActive": true,
          "IsSystem": true,
          "IsADBased": true,
          "BusinessUnitId": 9,
          "PermissionIds": [
            1,
            2
          ],
          "FullName": "sample string 3 sample string 4",
          "BusinessUnit": {
            "$id": "9",
            "$type": "AHS.Server.Entities.BusinessUnit, AHS.Server",
            "BusinessUnitId": 1,
            "Description": "sample string 2",
            "IsAHS": true
          }
        },
        "ModifiedByUser": {
          "$ref": "8"
        }
      },
      {
        "$ref": "7"
      }
    ],
    "ConversationCategory": {
      "$id": "10",
      "$type": "NE.Entities.Server.HT.ConversationCategory, NE.Entities.Server",
      "CodeName": "sample string 1",
      "ConversationCategoryId": 2,
      "Description": "sample string 3",
      "Conversations": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    "ConversationResponseType": {
      "$id": "11",
      "$type": "NE.Entities.Server.HT.ConversationResponseType, NE.Entities.Server",
      "CodeName": "sample string 1",
      "ConversationResponseTypeId": 64,
      "Description": "sample string 3",
      "Conversations": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    "ConversationStatus": {
      "$id": "12",
      "$type": "NE.Entities.Server.HT.ConversationStatus, NE.Entities.Server",
      "CodeName": "sample string 1",
      "ConversationStatusId": 64,
      "Description": "sample string 3",
      "Conversations": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    "ConversationType": {
      "$id": "13",
      "$type": "NE.Entities.Server.HT.ConversationType, NE.Entities.Server",
      "CodeName": "sample string 1",
      "ConversationTypeId": 64,
      "Description": "sample string 3",
      "Conversations": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    "CreatedByUser": {
      "$ref": "8"
    },
    "ModifiedByUser": {
      "$ref": "8"
    }
  },
  {
    "$ref": "1"
  }
]