Find an Event

GET

/api/Event/Search

GET

/api/Event/Search

curl -G https://api.virtuoussoftware.com/api/Event/Search \
     -H "Authorization: Bearer <token>" \
     --data-urlencode filter=<string>

200Events_findAnEvent_example

[
  {
    "id": "<integer>",
    "eventViewUrl": "<string>",
    "name": "<string>",
    "eventType": "<string>",
    "locationName": "<string>",
    "displayAddress": "<string>",
    "geocodeAddress": "<string>",
    "startDateTime": "<string>",
    "endDateTime": "<string>",
    "timeZone": "<string>",
    "description": "<string>",
    "specialInstructions": "<string>",
    "inviteOnly": "<boolean>",
    "rsvpRequired": "<boolean>",
    "totalInvites": "<integer>",
    "totalRsvps": "<integer>",
    "totalAttended": "<integer>",
    "totalGifts": "<integer>",
    "totalGiving": "<string>",
    "communicationId": "<integer>",
    "createDateTimeUtc": "<dateTime>",
    "createdByUser": "<string>",
    "modifiedDateTimeUtc": "<dateTime>",
    "modifiedByUser": "<string>",
    "eventContactsUrl": "<string>",
    "generosityEventContacts": [
      {
        "id": "<integer>",
        "eventContactUrl": "<string>",
        "contactId": "<integer>",
        "contactUrl": "<string>",
        "displayName": "<string>",
        "firstName": "<string>",
        "avatarUrl": "<string>",
        "primaryPhone": "<string>",
        "primaryEmail": "<string>"
      },
      {
        "id": "<integer>",
        "eventContactUrl": "<string>",
        "contactId": "<integer>",
        "contactUrl": "<string>",
        "displayName": "<string>",
        "firstName": "<string>",
        "avatarUrl": "<string>",
        "primaryPhone": "<string>",
        "primaryEmail": "<string>"
      }
    ],
    "tables": [
      "<string>",
      "<string>"
    ],
    "meals": [
      "<string>",
      "<string>"
    ],
    "eventInvitationsUrl": "<string>",
    "customFields": [
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      },
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      }
    ]
  },
  {
    "id": "<integer>",
    "eventViewUrl": "<string>",
    "name": "<string>",
    "eventType": "<string>",
    "locationName": "<string>",
    "displayAddress": "<string>",
    "geocodeAddress": "<string>",
    "startDateTime": "<string>",
    "endDateTime": "<string>",
    "timeZone": "<string>",
    "description": "<string>",
    "specialInstructions": "<string>",
    "inviteOnly": "<boolean>",
    "rsvpRequired": "<boolean>",
    "totalInvites": "<integer>",
    "totalRsvps": "<integer>",
    "totalAttended": "<integer>",
    "totalGifts": "<integer>",
    "totalGiving": "<string>",
    "communicationId": "<integer>",
    "eventContactsUrl": "<string>",
    "generosityEventContacts": [
      {
        "id": "<integer>",
        "eventContactUrl": "<string>",
        "contactId": "<integer>",
        "contactUrl": "<string>",
        "displayName": "<string>",
        "firstName": "<string>",
        "avatarUrl": "<string>",
        "primaryPhone": "<string>",
        "primaryEmail": "<string>"
      },
      {
        "id": "<integer>",
        "eventContactUrl": "<string>",
        "contactId": "<integer>",
        "contactUrl": "<string>",
        "displayName": "<string>",
        "firstName": "<string>",
        "avatarUrl": "<string>",
        "primaryPhone": "<string>",
        "primaryEmail": "<string>"
      }
    ],
    "tables": [
      "<string>",
      "<string>"
    ],
    "meals": [
      "<string>",
      "<string>"
    ],
    "eventInvitationsUrl": "<string>",
    "customFields": [
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      },
      {
        "name": "<string>",
        "value": "<string>",
        "displayName": "<string>"
      }
    ]
  }
]

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

filterstringOptional

(Required) The filter.

Response

idstringOptional

eventViewUrlstringOptional

namestringOptional

eventTypestringOptional

locationNamestringOptional

displayAddressstringOptional

geocodeAddressstringOptional

startDateTimestringOptional

endDateTimestringOptional

timeZonestringOptional

descriptionstringOptional

specialInstructionsstringOptional

inviteOnlystringOptional

rsvpRequiredstringOptional

totalInvitesstringOptional

totalRsvpsstringOptional

totalAttendedstringOptional

totalGiftsstringOptional

totalGivingstringOptional

communicationIdstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

eventContactsUrlstringOptional

generosityEventContactslist of objectsOptional

tableslist of stringsOptional

mealslist of stringsOptional

eventInvitationsUrlstringOptional

customFieldslist of objectsOptional