GET api/Village/{village}/Conversations?archived={archived}

Get a list of conversations in the village

Request Information

URI Parameters

Name	Description	Type	Additional information
archived	If specified, includes only conversations which are (true) or are not (false) archived. If not specified, returns all conversations	boolean	None.
village		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ConversationModel

Name	Description	Type	Additional information
ConversationId	Conversation's Unique ID	globally unique identifier	None.
VillageId	Village's Unique ID	globally unique identifier	None.
ConversationType	Indicates the conversation type (0 = Group, 1 = Village, 2 = Private)	ConversationType	None.
VillageConversation	OBSOLETE, use ConversationType instead. If true, this is the default conversation for the Village	boolean	None.
Archived	If true, the user has archived this conversation	boolean	None.
NewMessages	The number of new messages since the last mesage the user read	integer	None.
Title	The title of the conversation (will be Village Name for the village conversation, or the name of the "other user" for a 1:1 conversation	string	None.
Created	Date/Time the conversation was created	date	None.
OtherUserId	Obsolete - ID of the other private conversation participant	globally unique identifier	None.
MessageCount	Number of messages in the conversation	integer	None.
LastRead	Sequence of the user's last-read message	integer	None.
LastMessage	The last message sent in the conversation	string	None.
LastMessageIsAction	If true, the last message is an "Action" message (something happened, vs. something was said)	boolean	None.
LastMessageSent	When the last message was sent	date	None.
LastMessageSentById	ID of the user who sent the last message	globally unique identifier	None.
LastMessageSentBy	Name (First L.) of the user who sent the last message	string	None.
OtherUsers	List of other conversation participants	Collection of ConversationMemberModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ConversationId": "d38ab11b-5358-4ad6-97b8-424392420377",
    "VillageId": "eebe9ccf-0e9f-47db-8cee-854cf2fc50a7",
    "ConversationType": 0,
    "VillageConversation": false,
    "Archived": true,
    "NewMessages": 4,
    "Title": "sample string 5",
    "Created": "2025-06-03T05:14:02.404+00:00",
    "OtherUserId": null,
    "MessageCount": 7,
    "LastRead": 1,
    "LastMessage": "sample string 8",
    "LastMessageIsAction": true,
    "LastMessageSent": "2025-06-03T05:14:02.404+00:00",
    "LastMessageSentById": "3bce78fd-2622-4d4f-9205-4ac31469b8e6",
    "LastMessageSentBy": "sample string 9",
    "OtherUsers": [
      {
        "VillagerId": "15b67189-a7fc-402d-bee7-d8839e1bd283",
        "Name": "sample string 2"
      },
      {
        "VillagerId": "15b67189-a7fc-402d-bee7-d8839e1bd283",
        "Name": "sample string 2"
      }
    ]
  },
  {
    "ConversationId": "d38ab11b-5358-4ad6-97b8-424392420377",
    "VillageId": "eebe9ccf-0e9f-47db-8cee-854cf2fc50a7",
    "ConversationType": 0,
    "VillageConversation": false,
    "Archived": true,
    "NewMessages": 4,
    "Title": "sample string 5",
    "Created": "2025-06-03T05:14:02.404+00:00",
    "OtherUserId": null,
    "MessageCount": 7,
    "LastRead": 1,
    "LastMessage": "sample string 8",
    "LastMessageIsAction": true,
    "LastMessageSent": "2025-06-03T05:14:02.404+00:00",
    "LastMessageSentById": "3bce78fd-2622-4d4f-9205-4ac31469b8e6",
    "LastMessageSentBy": "sample string 9",
    "OtherUsers": [
      {
        "VillagerId": "15b67189-a7fc-402d-bee7-d8839e1bd283",
        "Name": "sample string 2"
      },
      {
        "VillagerId": "15b67189-a7fc-402d-bee7-d8839e1bd283",
        "Name": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfConversationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <ConversationModel>
    <Archived>true</Archived>
    <ConversationId>d38ab11b-5358-4ad6-97b8-424392420377</ConversationId>
    <ConversationType>Group</ConversationType>
    <Created>2025-06-03T05:14:02.4045864+00:00</Created>
    <LastMessage>sample string 8</LastMessage>
    <LastMessageIsAction>true</LastMessageIsAction>
    <LastMessageSent>2025-06-03T05:14:02.4045864+00:00</LastMessageSent>
    <LastMessageSentBy>sample string 9</LastMessageSentBy>
    <LastMessageSentById>3bce78fd-2622-4d4f-9205-4ac31469b8e6</LastMessageSentById>
    <LastRead>1</LastRead>
    <MessageCount>7</MessageCount>
    <NewMessages>4</NewMessages>
    <OtherUsers>
      <ConversationMemberModel>
        <Name>sample string 2</Name>
        <VillagerId>15b67189-a7fc-402d-bee7-d8839e1bd283</VillagerId>
      </ConversationMemberModel>
      <ConversationMemberModel>
        <Name>sample string 2</Name>
        <VillagerId>15b67189-a7fc-402d-bee7-d8839e1bd283</VillagerId>
      </ConversationMemberModel>
    </OtherUsers>
    <Title>sample string 5</Title>
    <VillageId>eebe9ccf-0e9f-47db-8cee-854cf2fc50a7</VillageId>
  </ConversationModel>
  <ConversationModel>
    <Archived>true</Archived>
    <ConversationId>d38ab11b-5358-4ad6-97b8-424392420377</ConversationId>
    <ConversationType>Group</ConversationType>
    <Created>2025-06-03T05:14:02.4045864+00:00</Created>
    <LastMessage>sample string 8</LastMessage>
    <LastMessageIsAction>true</LastMessageIsAction>
    <LastMessageSent>2025-06-03T05:14:02.4045864+00:00</LastMessageSent>
    <LastMessageSentBy>sample string 9</LastMessageSentBy>
    <LastMessageSentById>3bce78fd-2622-4d4f-9205-4ac31469b8e6</LastMessageSentById>
    <LastRead>1</LastRead>
    <MessageCount>7</MessageCount>
    <NewMessages>4</NewMessages>
    <OtherUsers>
      <ConversationMemberModel>
        <Name>sample string 2</Name>
        <VillagerId>15b67189-a7fc-402d-bee7-d8839e1bd283</VillagerId>
      </ConversationMemberModel>
      <ConversationMemberModel>
        <Name>sample string 2</Name>
        <VillagerId>15b67189-a7fc-402d-bee7-d8839e1bd283</VillagerId>
      </ConversationMemberModel>
    </OtherUsers>
    <Title>sample string 5</Title>
    <VillageId>eebe9ccf-0e9f-47db-8cee-854cf2fc50a7</VillageId>
  </ConversationModel>
</ArrayOfConversationModel>