GET api/Village/{village}/Events

Get events matching specified criteria

Request Information

URI Parameters

Name	Description	Type	Additional information
village	Village ID	globally unique identifier	Required
WithReminders	If true, ToDo Reminders will be included in the result set. If false, Todo reminders will not be included. Defaults to true	boolean	None.
WithEvents	If true, Events will be included in the result set. If false, events will not be included. Defaults to true.	boolean	None.
WithCancelled	If true, deleted events will be included in the result set. If false, deleted events will not be included. Defaults to false	boolean	None.
StartDate	If not null, include only events occuring on or after the StartDate (events which start before and end after the start date will also be included)	date	None.
EndDate	If not null, include only events occuring on or after the StartDate (events which start before and end after the end date will also be included)	date	None.
AssignedToUserId	If set, retrieves activities assigned to the specified user. If not set, returns activities regardless of user assignment. To retrieve unassigned activities, pass the special value Guid.Empty (00000000-0000-0000-0000-000000000000).	globally unique identifier	None.
WithHistory	If true, the activity history (comments, assignments, etc.) will be included for all activities in the result; defaults to false	boolean	None.
SearchText	If provided, include only activities which contain the specified SearchText in a text field	string	None.
Tags	If provided, include only activities containing one or more of the specified tags	Collection of string	None.
LastUpdated	If set, returns events updated >= value	date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ViewEventModel

Name	Description	Type	Additional information
Description	Full description of the event	string	None.
NeedAssignees	Event requires assignees (i.e. Assignees is toggled on)	boolean	None.
Priority	Whether or not the event is priority	boolean	None.
StartTime	Event's start Date and Time	date	None.
EndTime	Events end Date and Time	date	None.
AllDay	If true, this is an all day event and the time portion of StartTime/EndTime are not relevant	boolean	None.
Location	Location of event	string	None.
Address	Event Location Address	OptionalAddressModel	None.
Reminder	For Events which are actually ToDo reminders, contains the rest of the ToDo information	ReminderModel	None.
ReminderInterval	For Events which are events, the #minutes before the start to send a reminder	integer	None.
Recurrence	For recurring events, the recurrence definition. null, otherwise.	ViewEventRecurrenceModel	None.
TimeZone	Time Zone for the Event	string	None.
ActivityId	Activity's unique ID	globally unique identifier	None.
CreatedById	ID of the user who created the activity	globally unique identifier	None.
CreatedBy	Name of the user who created the activity	string	None.
Created	Date/Time when the activity was created	date	None.
AssignedTo	List of users the activity is assigned to	Collection of ActivityAssignmentModel	None.
Tags	List of tags for the activity	Collection of string	None.
Attachments	File attachments	Collection of AttachmentModel	None.
History	Activity activity history	Collection of ActivityHistoryModel	None.
CommentCount	Number of entries in History which are comments	integer	None.
VillageId	The ID of the village in which this activity belongs	globally unique identifier	None.
LastUpdated	The date/time this activity was last updated; useful for handling push notifications	date	None.
Cancelled	True for activities that have been cancelled. Default value is false	boolean	None.
Title	Short title for the activity	string	Required String length: inclusive between 0 and 255

Response Formats

application/json, text/json

Sample:

[
  {
    "Description": "sample string 1",
    "NeedAssignees": true,
    "Priority": true,
    "StartTime": "2025-06-03T02:30:41.635+00:00",
    "EndTime": "2025-06-03T02:30:41.635+00:00",
    "AllDay": true,
    "Location": "sample string 7",
    "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"
    },
    "Reminder": {
      "Reminder": "2025-06-03T02:30:41.635+00:00",
      "Completed": "2025-06-03T02:30:41.635+00:00",
      "CompletedById": "5f104c97-665c-4a6e-9c38-237d82a963a3",
      "CompletedBy": "sample string 1"
    },
    "ReminderInterval": 1,
    "Recurrence": {
      "StartDate": "2025-06-03T02:30:41.635+00:00",
      "Exceptions": [
        {
          "Date": "2025-06-03T02:30:41.635+00:00"
        },
        {
          "Date": "2025-06-03T02:30:41.635+00:00"
        }
      ],
      "EventId": "0c7b640f-a981-4a29-ae25-535cb00cdf77",
      "EndDate": "2025-06-03T02:30:41.635+00:00",
      "Count": 3,
      "Frequency": 0,
      "Interval": 4,
      "Weekdays": 1
    },
    "TimeZone": "sample string 8",
    "ActivityId": "1264d28d-3762-4939-99cf-6dd846c33f35",
    "CreatedById": "551e47ef-f7f5-40d5-bc7b-8d10b9f5100d",
    "CreatedBy": "sample string 11",
    "Created": "2025-06-03T02:30:41.635+00:00",
    "AssignedTo": [
      {
        "UserId": "7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b",
        "Name": "sample string 2"
      },
      {
        "UserId": "7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b",
        "Name": "sample string 2"
      }
    ],
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Attachments": [
      {
        "Id": "315e5950-a36d-4661-8db2-b820187c44cb",
        "Size": 2,
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "UploadedBy": "sample string 5"
      },
      {
        "Id": "315e5950-a36d-4661-8db2-b820187c44cb",
        "Size": 2,
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "UploadedBy": "sample string 5"
      }
    ],
    "History": [
      {
        "HistoryId": "e3d8263d-6f15-4fb6-9a0c-2232f7b07a68",
        "ActivityId": "c6f3e719-6d8f-4335-8c3f-6b02ea94219a",
        "PerformedById": "52e910cb-5124-49e5-bf04-680198611f80",
        "PerformedBy": "sample string 4",
        "AssignedToId": "9fff3778-267d-4f02-b3e8-54839628a74b",
        "AssignedTo": "sample string 5",
        "Action": "Comment",
        "DateTime": "2025-06-03T02:30:41.635+00:00",
        "Comments": "sample string 7",
        "Updated": "2025-06-03T02:30:41.635+00:00",
        "UpdatedById": "c74bb8d8-650f-446c-8a05-3d0072447979",
        "UpdatedBy": "sample string 10"
      },
      {
        "HistoryId": "e3d8263d-6f15-4fb6-9a0c-2232f7b07a68",
        "ActivityId": "c6f3e719-6d8f-4335-8c3f-6b02ea94219a",
        "PerformedById": "52e910cb-5124-49e5-bf04-680198611f80",
        "PerformedBy": "sample string 4",
        "AssignedToId": "9fff3778-267d-4f02-b3e8-54839628a74b",
        "AssignedTo": "sample string 5",
        "Action": "Comment",
        "DateTime": "2025-06-03T02:30:41.635+00:00",
        "Comments": "sample string 7",
        "Updated": "2025-06-03T02:30:41.635+00:00",
        "UpdatedById": "c74bb8d8-650f-446c-8a05-3d0072447979",
        "UpdatedBy": "sample string 10"
      }
    ],
    "CommentCount": 2,
    "VillageId": "2bf59bc0-cc28-4dd9-9280-469fe2ee2835",
    "LastUpdated": "2025-06-03T02:30:41.635+00:00",
    "Cancelled": true,
    "Title": "sample string 16"
  },
  {
    "Description": "sample string 1",
    "NeedAssignees": true,
    "Priority": true,
    "StartTime": "2025-06-03T02:30:41.635+00:00",
    "EndTime": "2025-06-03T02:30:41.635+00:00",
    "AllDay": true,
    "Location": "sample string 7",
    "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"
    },
    "Reminder": {
      "Reminder": "2025-06-03T02:30:41.635+00:00",
      "Completed": "2025-06-03T02:30:41.635+00:00",
      "CompletedById": "5f104c97-665c-4a6e-9c38-237d82a963a3",
      "CompletedBy": "sample string 1"
    },
    "ReminderInterval": 1,
    "Recurrence": {
      "StartDate": "2025-06-03T02:30:41.635+00:00",
      "Exceptions": [
        {
          "Date": "2025-06-03T02:30:41.635+00:00"
        },
        {
          "Date": "2025-06-03T02:30:41.635+00:00"
        }
      ],
      "EventId": "0c7b640f-a981-4a29-ae25-535cb00cdf77",
      "EndDate": "2025-06-03T02:30:41.635+00:00",
      "Count": 3,
      "Frequency": 0,
      "Interval": 4,
      "Weekdays": 1
    },
    "TimeZone": "sample string 8",
    "ActivityId": "1264d28d-3762-4939-99cf-6dd846c33f35",
    "CreatedById": "551e47ef-f7f5-40d5-bc7b-8d10b9f5100d",
    "CreatedBy": "sample string 11",
    "Created": "2025-06-03T02:30:41.635+00:00",
    "AssignedTo": [
      {
        "UserId": "7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b",
        "Name": "sample string 2"
      },
      {
        "UserId": "7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b",
        "Name": "sample string 2"
      }
    ],
    "Tags": [
      "sample string 1",
      "sample string 2"
    ],
    "Attachments": [
      {
        "Id": "315e5950-a36d-4661-8db2-b820187c44cb",
        "Size": 2,
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "UploadedBy": "sample string 5"
      },
      {
        "Id": "315e5950-a36d-4661-8db2-b820187c44cb",
        "Size": 2,
        "FileName": "sample string 3",
        "ContentType": "sample string 4",
        "UploadedBy": "sample string 5"
      }
    ],
    "History": [
      {
        "HistoryId": "e3d8263d-6f15-4fb6-9a0c-2232f7b07a68",
        "ActivityId": "c6f3e719-6d8f-4335-8c3f-6b02ea94219a",
        "PerformedById": "52e910cb-5124-49e5-bf04-680198611f80",
        "PerformedBy": "sample string 4",
        "AssignedToId": "9fff3778-267d-4f02-b3e8-54839628a74b",
        "AssignedTo": "sample string 5",
        "Action": "Comment",
        "DateTime": "2025-06-03T02:30:41.635+00:00",
        "Comments": "sample string 7",
        "Updated": "2025-06-03T02:30:41.635+00:00",
        "UpdatedById": "c74bb8d8-650f-446c-8a05-3d0072447979",
        "UpdatedBy": "sample string 10"
      },
      {
        "HistoryId": "e3d8263d-6f15-4fb6-9a0c-2232f7b07a68",
        "ActivityId": "c6f3e719-6d8f-4335-8c3f-6b02ea94219a",
        "PerformedById": "52e910cb-5124-49e5-bf04-680198611f80",
        "PerformedBy": "sample string 4",
        "AssignedToId": "9fff3778-267d-4f02-b3e8-54839628a74b",
        "AssignedTo": "sample string 5",
        "Action": "Comment",
        "DateTime": "2025-06-03T02:30:41.635+00:00",
        "Comments": "sample string 7",
        "Updated": "2025-06-03T02:30:41.635+00:00",
        "UpdatedById": "c74bb8d8-650f-446c-8a05-3d0072447979",
        "UpdatedBy": "sample string 10"
      }
    ],
    "CommentCount": 2,
    "VillageId": "2bf59bc0-cc28-4dd9-9280-469fe2ee2835",
    "LastUpdated": "2025-06-03T02:30:41.635+00:00",
    "Cancelled": true,
    "Title": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfViewEventModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CaringVillage.Shared.Implementation.Models">
  <ViewEventModel>
    <Title>sample string 16</Title>
    <ActivityId>1264d28d-3762-4939-99cf-6dd846c33f35</ActivityId>
    <AssignedTo>
      <ActivityAssignmentModel>
        <Name>sample string 2</Name>
        <UserId>7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b</UserId>
      </ActivityAssignmentModel>
      <ActivityAssignmentModel>
        <Name>sample string 2</Name>
        <UserId>7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b</UserId>
      </ActivityAssignmentModel>
    </AssignedTo>
    <Attachments>
      <AttachmentModel>
        <ContentType>sample string 4</ContentType>
        <FileName>sample string 3</FileName>
        <Id>315e5950-a36d-4661-8db2-b820187c44cb</Id>
        <Size>2</Size>
        <UploadedBy>sample string 5</UploadedBy>
      </AttachmentModel>
      <AttachmentModel>
        <ContentType>sample string 4</ContentType>
        <FileName>sample string 3</FileName>
        <Id>315e5950-a36d-4661-8db2-b820187c44cb</Id>
        <Size>2</Size>
        <UploadedBy>sample string 5</UploadedBy>
      </AttachmentModel>
    </Attachments>
    <Cancelled>true</Cancelled>
    <Created>2025-06-03T02:30:41.6359182+00:00</Created>
    <CreatedBy>sample string 11</CreatedBy>
    <CreatedById>551e47ef-f7f5-40d5-bc7b-8d10b9f5100d</CreatedById>
    <History>
      <ActivityHistoryModel>
        <ActivityId>c6f3e719-6d8f-4335-8c3f-6b02ea94219a</ActivityId>
        <AssignedTo>sample string 5</AssignedTo>
        <AssignedToId>9fff3778-267d-4f02-b3e8-54839628a74b</AssignedToId>
        <Comments>sample string 7</Comments>
        <DateTime>2025-06-03T02:30:41.6359182+00:00</DateTime>
        <HistoryId>e3d8263d-6f15-4fb6-9a0c-2232f7b07a68</HistoryId>
        <PerformedBy>sample string 4</PerformedBy>
        <PerformedById>52e910cb-5124-49e5-bf04-680198611f80</PerformedById>
        <Updated>2025-06-03T02:30:41.6359182+00:00</Updated>
        <UpdatedBy>sample string 10</UpdatedBy>
        <UpdatedById>c74bb8d8-650f-446c-8a05-3d0072447979</UpdatedById>
      </ActivityHistoryModel>
      <ActivityHistoryModel>
        <ActivityId>c6f3e719-6d8f-4335-8c3f-6b02ea94219a</ActivityId>
        <AssignedTo>sample string 5</AssignedTo>
        <AssignedToId>9fff3778-267d-4f02-b3e8-54839628a74b</AssignedToId>
        <Comments>sample string 7</Comments>
        <DateTime>2025-06-03T02:30:41.6359182+00:00</DateTime>
        <HistoryId>e3d8263d-6f15-4fb6-9a0c-2232f7b07a68</HistoryId>
        <PerformedBy>sample string 4</PerformedBy>
        <PerformedById>52e910cb-5124-49e5-bf04-680198611f80</PerformedById>
        <Updated>2025-06-03T02:30:41.6359182+00:00</Updated>
        <UpdatedBy>sample string 10</UpdatedBy>
        <UpdatedById>c74bb8d8-650f-446c-8a05-3d0072447979</UpdatedById>
      </ActivityHistoryModel>
    </History>
    <LastUpdated>2025-06-03T02:30:41.6359182+00:00</LastUpdated>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
    <VillageId>2bf59bc0-cc28-4dd9-9280-469fe2ee2835</VillageId>
    <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>
    <AllDay>true</AllDay>
    <Description>sample string 1</Description>
    <EndTime>2025-06-03T02:30:41.6359182+00:00</EndTime>
    <Location>sample string 7</Location>
    <NeedAssignees>true</NeedAssignees>
    <Priority>true</Priority>
    <Recurrence>
      <Count>3</Count>
      <EndDate>2025-06-03T02:30:41.6359182+00:00</EndDate>
      <EventId>0c7b640f-a981-4a29-ae25-535cb00cdf77</EventId>
      <Frequency>None</Frequency>
      <Interval>4</Interval>
      <Weekdays>Sunday</Weekdays>
      <Exceptions>
        <EventRecurrenceExceptionsModel>
          <Date>2025-06-03T02:30:41.6359182+00:00</Date>
        </EventRecurrenceExceptionsModel>
        <EventRecurrenceExceptionsModel>
          <Date>2025-06-03T02:30:41.6359182+00:00</Date>
        </EventRecurrenceExceptionsModel>
      </Exceptions>
      <StartDate>2025-06-03T02:30:41.6359182+00:00</StartDate>
    </Recurrence>
    <Reminder>
      <Completed>2025-06-03T02:30:41.6359182+00:00</Completed>
      <CompletedBy>sample string 1</CompletedBy>
      <CompletedById>5f104c97-665c-4a6e-9c38-237d82a963a3</CompletedById>
      <Reminder>2025-06-03T02:30:41.6359182+00:00</Reminder>
    </Reminder>
    <ReminderInterval>1</ReminderInterval>
    <StartTime>2025-06-03T02:30:41.6359182+00:00</StartTime>
    <TimeZone>sample string 8</TimeZone>
  </ViewEventModel>
  <ViewEventModel>
    <Title>sample string 16</Title>
    <ActivityId>1264d28d-3762-4939-99cf-6dd846c33f35</ActivityId>
    <AssignedTo>
      <ActivityAssignmentModel>
        <Name>sample string 2</Name>
        <UserId>7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b</UserId>
      </ActivityAssignmentModel>
      <ActivityAssignmentModel>
        <Name>sample string 2</Name>
        <UserId>7a6d84e7-d1ef-4098-9dcb-e96bc30bea5b</UserId>
      </ActivityAssignmentModel>
    </AssignedTo>
    <Attachments>
      <AttachmentModel>
        <ContentType>sample string 4</ContentType>
        <FileName>sample string 3</FileName>
        <Id>315e5950-a36d-4661-8db2-b820187c44cb</Id>
        <Size>2</Size>
        <UploadedBy>sample string 5</UploadedBy>
      </AttachmentModel>
      <AttachmentModel>
        <ContentType>sample string 4</ContentType>
        <FileName>sample string 3</FileName>
        <Id>315e5950-a36d-4661-8db2-b820187c44cb</Id>
        <Size>2</Size>
        <UploadedBy>sample string 5</UploadedBy>
      </AttachmentModel>
    </Attachments>
    <Cancelled>true</Cancelled>
    <Created>2025-06-03T02:30:41.6359182+00:00</Created>
    <CreatedBy>sample string 11</CreatedBy>
    <CreatedById>551e47ef-f7f5-40d5-bc7b-8d10b9f5100d</CreatedById>
    <History>
      <ActivityHistoryModel>
        <ActivityId>c6f3e719-6d8f-4335-8c3f-6b02ea94219a</ActivityId>
        <AssignedTo>sample string 5</AssignedTo>
        <AssignedToId>9fff3778-267d-4f02-b3e8-54839628a74b</AssignedToId>
        <Comments>sample string 7</Comments>
        <DateTime>2025-06-03T02:30:41.6359182+00:00</DateTime>
        <HistoryId>e3d8263d-6f15-4fb6-9a0c-2232f7b07a68</HistoryId>
        <PerformedBy>sample string 4</PerformedBy>
        <PerformedById>52e910cb-5124-49e5-bf04-680198611f80</PerformedById>
        <Updated>2025-06-03T02:30:41.6359182+00:00</Updated>
        <UpdatedBy>sample string 10</UpdatedBy>
        <UpdatedById>c74bb8d8-650f-446c-8a05-3d0072447979</UpdatedById>
      </ActivityHistoryModel>
      <ActivityHistoryModel>
        <ActivityId>c6f3e719-6d8f-4335-8c3f-6b02ea94219a</ActivityId>
        <AssignedTo>sample string 5</AssignedTo>
        <AssignedToId>9fff3778-267d-4f02-b3e8-54839628a74b</AssignedToId>
        <Comments>sample string 7</Comments>
        <DateTime>2025-06-03T02:30:41.6359182+00:00</DateTime>
        <HistoryId>e3d8263d-6f15-4fb6-9a0c-2232f7b07a68</HistoryId>
        <PerformedBy>sample string 4</PerformedBy>
        <PerformedById>52e910cb-5124-49e5-bf04-680198611f80</PerformedById>
        <Updated>2025-06-03T02:30:41.6359182+00:00</Updated>
        <UpdatedBy>sample string 10</UpdatedBy>
        <UpdatedById>c74bb8d8-650f-446c-8a05-3d0072447979</UpdatedById>
      </ActivityHistoryModel>
    </History>
    <LastUpdated>2025-06-03T02:30:41.6359182+00:00</LastUpdated>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </Tags>
    <VillageId>2bf59bc0-cc28-4dd9-9280-469fe2ee2835</VillageId>
    <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>
    <AllDay>true</AllDay>
    <Description>sample string 1</Description>
    <EndTime>2025-06-03T02:30:41.6359182+00:00</EndTime>
    <Location>sample string 7</Location>
    <NeedAssignees>true</NeedAssignees>
    <Priority>true</Priority>
    <Recurrence>
      <Count>3</Count>
      <EndDate>2025-06-03T02:30:41.6359182+00:00</EndDate>
      <EventId>0c7b640f-a981-4a29-ae25-535cb00cdf77</EventId>
      <Frequency>None</Frequency>
      <Interval>4</Interval>
      <Weekdays>Sunday</Weekdays>
      <Exceptions>
        <EventRecurrenceExceptionsModel>
          <Date>2025-06-03T02:30:41.6359182+00:00</Date>
        </EventRecurrenceExceptionsModel>
        <EventRecurrenceExceptionsModel>
          <Date>2025-06-03T02:30:41.6359182+00:00</Date>
        </EventRecurrenceExceptionsModel>
      </Exceptions>
      <StartDate>2025-06-03T02:30:41.6359182+00:00</StartDate>
    </Recurrence>
    <Reminder>
      <Completed>2025-06-03T02:30:41.6359182+00:00</Completed>
      <CompletedBy>sample string 1</CompletedBy>
      <CompletedById>5f104c97-665c-4a6e-9c38-237d82a963a3</CompletedById>
      <Reminder>2025-06-03T02:30:41.6359182+00:00</Reminder>
    </Reminder>
    <ReminderInterval>1</ReminderInterval>
    <StartTime>2025-06-03T02:30:41.6359182+00:00</StartTime>
    <TimeZone>sample string 8</TimeZone>
  </ViewEventModel>
</ArrayOfViewEventModel>