Query Events
POST {{baseUrl}}/api/Event/Query?skip=<integer>&take=<integer>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. Max is 1000. |
Request Body
{"groups"=>[{"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}, {"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}], "sortBy"=>"<string>", "descending"=>"<boolean>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"list":[{"id":"\u003cinteger\u003e","eventViewUrl":"\u003cstring\u003e","name":"\u003cstring\u003e","eventType":"\u003cstring\u003e","locationName":"\u003cstring\u003e","displayAddress":"\u003cstring\u003e","geocodeAddress":"\u003cstring\u003e","startDateTime":"\u003cstring\u003e","endDateTime":"\u003cstring\u003e","timeZone":"\u003cstring\u003e","description":"\u003cstring\u003e","specialInstructions":"\u003cstring\u003e","inviteOnly":"\u003cboolean\u003e","rsvpRequired":"\u003cboolean\u003e","totalInvites":"\u003cinteger\u003e","totalRsvps":"\u003cinteger\u003e","totalAttended":"\u003cinteger\u003e","totalGifts":"\u003cinteger\u003e","totalGiving":"\u003cstring\u003e","communicationId":"\u003cinteger\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","eventContactsUrl":"\u003cstring\u003e","generosityEventContacts":[{"id":"\u003cinteger\u003e","eventContactUrl":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactUrl":"\u003cstring\u003e","displayName":"\u003cstring\u003e","firstName":"\u003cstring\u003e","avatarUrl":"\u003cstring\u003e","primaryPhone":"\u003cstring\u003e","primaryEmail":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","eventContactUrl":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactUrl":"\u003cstring\u003e","displayName":"\u003cstring\u003e","firstName":"\u003cstring\u003e","avatarUrl":"\u003cstring\u003e","primaryPhone":"\u003cstring\u003e","primaryEmail":"\u003cstring\u003e"}],"tables":["\u003cstring\u003e","\u003cstring\u003e"],"meals":["\u003cstring\u003e","\u003cstring\u003e"],"eventInvitationsUrl":"\u003cstring\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]},{"id":"\u003cinteger\u003e","eventViewUrl":"\u003cstring\u003e","name":"\u003cstring\u003e","eventType":"\u003cstring\u003e","locationName":"\u003cstring\u003e","displayAddress":"\u003cstring\u003e","geocodeAddress":"\u003cstring\u003e","startDateTime":"\u003cstring\u003e","endDateTime":"\u003cstring\u003e","timeZone":"\u003cstring\u003e","description":"\u003cstring\u003e","specialInstructions":"\u003cstring\u003e","inviteOnly":"\u003cboolean\u003e","rsvpRequired":"\u003cboolean\u003e","totalInvites":"\u003cinteger\u003e","totalRsvps":"\u003cinteger\u003e","totalAttended":"\u003cinteger\u003e","totalGifts":"\u003cinteger\u003e","totalGiving":"\u003cstring\u003e","communicationId":"\u003cinteger\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","eventContactsUrl":"\u003cstring\u003e","generosityEventContacts":[{"id":"\u003cinteger\u003e","eventContactUrl":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactUrl":"\u003cstring\u003e","displayName":"\u003cstring\u003e","firstName":"\u003cstring\u003e","avatarUrl":"\u003cstring\u003e","primaryPhone":"\u003cstring\u003e","primaryEmail":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","eventContactUrl":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","contactUrl":"\u003cstring\u003e","displayName":"\u003cstring\u003e","firstName":"\u003cstring\u003e","avatarUrl":"\u003cstring\u003e","primaryPhone":"\u003cstring\u003e","primaryEmail":"\u003cstring\u003e"}],"tables":["\u003cstring\u003e","\u003cstring\u003e"],"meals":["\u003cstring\u003e","\u003cstring\u003e"],"eventInvitationsUrl":"\u003cstring\u003e","customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}],"total":"\u003cinteger\u003e"}