GET api/Village/{village}/Villagers?withInvitations={withInvitations}

OBSOLETE: Get a list of villagers for the specified village This method has been replaced by the 'GET Members' API call in this section, and the 'GET Invitations' API call in the Invitation section

Request Information

URI Parameters

Name	Description	Type	Additional information
village	Village ID	globally unique identifier	Required
withInvitations	Whether or not invitations should be included in the results	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ObsoleteVillagerModel

Name	Description	Type	Additional information
Id	Unique ID of this village:villager mapping	globally unique identifier	None.
VillageId	Village's unique ID	globally unique identifier	None.
VillagerId	Villager's unique ID	globally unique identifier	None.
FirstName	Villager's first name	string	None.
LastName	Villager's last name	string	None.
LastActivity	Last time the villager was active (or for invitations, the date the person was invited)	date	None.
IsInvite	If true, this is an invitation not an actual village member	boolean	None.
Role	Villager's role in the village (or pending role, for invitations)	UserVillageRole	None.
Email	Villager's email address	string	None.
AvatarUrl	URL for the villager's avatar, if any (null = use default avatar)	string	None.
PhoneNumber	Villager's Phone Number	string	None.
Address	Villager's Address	AddressModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "0d1c4c0b-8133-4f57-8341-7bd9085b811b",
    "VillageId": "78c9a1e1-5ee4-48fe-b349-f87f984764cf",
    "VillagerId": "dd9f9dba-67aa-4c07-a8a2-0158fec0c568",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "LastActivity": "2025-06-03T05:07:58.926+00:00",
    "IsInvite": true,
    "Role": 0,
    "Email": "sample string 7",
    "AvatarUrl": "sample string 8",
    "PhoneNumber": "sample string 9",
    "Address": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Country": "sample string 6"
    }
  },
  {
    "Id": "0d1c4c0b-8133-4f57-8341-7bd9085b811b",
    "VillageId": "78c9a1e1-5ee4-48fe-b349-f87f984764cf",
    "VillagerId": "dd9f9dba-67aa-4c07-a8a2-0158fec0c568",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "LastActivity": "2025-06-03T05:07:58.926+00:00",
    "IsInvite": true,
    "Role": 0,
    "Email": "sample string 7",
    "AvatarUrl": "sample string 8",
    "PhoneNumber": "sample string 9",
    "Address": {
      "Address1": "sample string 1",
      "Address2": "sample string 2",
      "City": "sample string 3",
      "State": "sample string 4",
      "Zip": "sample string 5",
      "Country": "sample string 6"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfObsoleteVillagerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <ObsoleteVillagerModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <AvatarUrl>sample string 8</AvatarUrl>
    <Email>sample string 7</Email>
    <FirstName>sample string 4</FirstName>
    <Id>0d1c4c0b-8133-4f57-8341-7bd9085b811b</Id>
    <IsInvite>true</IsInvite>
    <LastActivity>2025-06-03T05:07:58.9265196+00:00</LastActivity>
    <LastName>sample string 5</LastName>
    <PhoneNumber>sample string 9</PhoneNumber>
    <Role>Revoked</Role>
    <VillageId>78c9a1e1-5ee4-48fe-b349-f87f984764cf</VillageId>
    <VillagerId>dd9f9dba-67aa-4c07-a8a2-0158fec0c568</VillagerId>
  </ObsoleteVillagerModel>
  <ObsoleteVillagerModel>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/CaringVillage.Utilities">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <AvatarUrl>sample string 8</AvatarUrl>
    <Email>sample string 7</Email>
    <FirstName>sample string 4</FirstName>
    <Id>0d1c4c0b-8133-4f57-8341-7bd9085b811b</Id>
    <IsInvite>true</IsInvite>
    <LastActivity>2025-06-03T05:07:58.9265196+00:00</LastActivity>
    <LastName>sample string 5</LastName>
    <PhoneNumber>sample string 9</PhoneNumber>
    <Role>Revoked</Role>
    <VillageId>78c9a1e1-5ee4-48fe-b349-f87f984764cf</VillageId>
    <VillagerId>dd9f9dba-67aa-4c07-a8a2-0158fec0c568</VillagerId>
  </ObsoleteVillagerModel>
</ArrayOfObsoleteVillagerModel>