GET v1/events

Gets a list of events from the parameters provided

Request Information

URI Parameters

Name	Description	Type	Additional information
searchTerm	The text of the event search	string	None.
latitude	The center point latitude of the event search. Defaults to the latitude set on the portal	decimal number	None.
longitude	The center point longitude of the event search. Defaults to the longitude set on the portal	decimal number	None.
radius	The radius of the event search from the center. Defaults to what is set on the portal (normally 25)	decimal number	None.
categories	The categories to show in the search. Defaults to what is set on the portal	Collection of integer	None.
labels	The labels to show in the search.	Collection of string	None.
includeLabels	Include labels in the	boolean	None.
handPicked	Whether to return only Editors Picks	boolean	None.
limit	The number of records to return. Defaults to 25	integer	None.
page	What page of events to return. Defaults to 1	integer	None.
lastUpdatedStart	The cutoff for event updates - events will be pulled after this point only if the updated date is after the specified date. Defaults to not being used as a filter	date	None.
startDate	The begin event date filter. Defaults to today	date	None.
endDate	The end. Defaults to not being used as a filter	date	None.
sortBy	The initial sort by. Defaults to sorting off of Popularity	SortBy	None.
sortAsc	Sort Ascending. Defaults to false for Popularity and true for all other sorts	boolean	None.
groupByDay	In addition to the primary sort events will be grouped by Day. Defaults to true	boolean	None.
portal	The portal context for which you will be retrieving events	string	Required
descriptionFormat	The format descriptions should be returned in. Currently only bold, italics, paragraphs and line breaks are supported	DescriptionFormat	None.

Body Parameters

None.

Response Information

Resource Description

A collection of events

GetEventsResponse

Name	Description	Type	Additional information
events		Collection of EventSeries	None.

Response Formats

application/json, text/json

Sample:

{
  "events": [
    {
      "eventId": 123,
      "name": "Save The World Get The Girl & Wired for Havoc & Paper Guns & Star-Off",
      "description": "SOMA PRESENTS: SAVE THE WORLD GET THE GIRL WIRED FOR HAVOC PAPER GUNS all ages 7pm $7 at 24tix.com",
      "primaryImage": {
        "smallImageUrl": "https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.small.png",
        "mediumImageUrl": "https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.medium.png",
        "largeImageUrl": "https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.large.png"
      },
      "categories": [
        {
          "categoryId": 1,
          "parentCategoryId": null,
          "name": "Performing Arts"
        },
        {
          "categoryId": 2,
          "parentCategoryId": 1,
          "name": "Music"
        }
      ],
      "location": {
        "latitude": 40.7600593566895,
        "longitude": -111.888221740723,
        "city": "Salt Lake City",
        "state": "UT",
        "address": "",
        "country": "United States",
        "locationName": "The Shred Shed SLC"
      },
      "instances": [
        {
          "startDateTime": "2024-07-01T18:30:00+00:00",
          "endDateTime": "2024-07-01T22:15:00+00:00",
          "hasTime": false,
          "allDay": false
        },
        {
          "startDateTime": "2024-07-04T18:30:00+00:00",
          "endDateTime": "2024-07-04T22:15:00+00:00",
          "hasTime": false,
          "allDay": false
        }
      ],
      "price": {
        "lowerPrice": 12.5,
        "upperPrice": 35.5,
        "free": false,
        "description": null
      },
      "lastUpdatedDate": "2024-06-29T09:31:23.7193137+00:00",
      "popularity": 55,
      "interest": 70,
      "links": [
        {
          "isSponsor": false,
          "name": "The Shred Shed SLC",
          "linkUrl": "https://www.facebook.com/ajax/events/ticket.php?event_id=1475358502694461&source=12&ext=1398844393&hash=ATXmHa4px1B5WNn5",
          "logoUrl": null
        }
      ],
      "previousEventIds": [
        19
      ],
      "seriesStart": "2024-07-01T18:30:00+00:00",
      "seriesEnd": "2024-07-04T18:30:00+00:00",
      "url": "http://www.yoursite.com/events/details/Save-The-World-Get-The-Girl/123/2014-08-27T10",
      "handPicked": false,
      "customField": null,
      "contact": null,
      "media": null
    }
  ]
}

text/xml

Sample:

<GetEventsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CitySpark.API.Models">
  <events>
    <EventSeries>
      <categories>
        <EventCategory>
          <categoryId>1</categoryId>
          <name>Performing Arts</name>
          <parentCategoryId i:nil="true" />
        </EventCategory>
        <EventCategory>
          <categoryId>2</categoryId>
          <name>Music</name>
          <parentCategoryId>1</parentCategoryId>
        </EventCategory>
      </categories>
      <contact i:nil="true" />
      <customField i:nil="true" />
      <description>SOMA PRESENTS: SAVE THE WORLD GET THE GIRL WIRED FOR HAVOC PAPER GUNS all ages 7pm $7 at 24tix.com</description>
      <eventId>123</eventId>
      <handPicked>false</handPicked>
      <instances>
        <EventInstance>
          <allDay>false</allDay>
          <endDateTime>2024-07-01T22:15:00+00:00</endDateTime>
          <hasTime>false</hasTime>
          <startDateTime>2024-07-01T18:30:00+00:00</startDateTime>
        </EventInstance>
        <EventInstance>
          <allDay>false</allDay>
          <endDateTime>2024-07-04T22:15:00+00:00</endDateTime>
          <hasTime>false</hasTime>
          <startDateTime>2024-07-04T18:30:00+00:00</startDateTime>
        </EventInstance>
      </instances>
      <interest>70</interest>
      <lastUpdatedDate>2024-06-29T09:31:23.7193137+00:00</lastUpdatedDate>
      <links>
        <EventLink>
          <isSponsor>false</isSponsor>
          <linkUrl>https://www.facebook.com/ajax/events/ticket.php?event_id=1475358502694461&amp;source=12&amp;ext=1398844393&amp;hash=ATXmHa4px1B5WNn5</linkUrl>
          <logoUrl i:nil="true" />
          <name>The Shred Shed SLC</name>
        </EventLink>
      </links>
      <location>
        <address></address>
        <city>Salt Lake City</city>
        <country>United States</country>
        <latitude>40.7600593566895</latitude>
        <locationName>The Shred Shed SLC</locationName>
        <longitude>-111.888221740723</longitude>
        <state>UT</state>
      </location>
      <media xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <name>Save The World Get The Girl &amp; Wired for Havoc &amp; Paper Guns &amp; Star-Off</name>
      <popularity>55</popularity>
      <previousEventIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>19</d4p1:long>
      </previousEventIds>
      <price>
        <description i:nil="true" />
        <free>false</free>
        <lowerPrice>12.5</lowerPrice>
        <upperPrice>35.5</upperPrice>
      </price>
      <primaryImage>
        <largeImageUrl>https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.large.png</largeImageUrl>
        <mediumImageUrl>https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.medium.png</mediumImageUrl>
        <smallImageUrl>https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.small.png</smallImageUrl>
      </primaryImage>
      <seriesEnd>2024-07-04T18:30:00+00:00</seriesEnd>
      <seriesStart>2024-07-01T18:30:00+00:00</seriesStart>
      <url>http://www.yoursite.com/events/details/Save-The-World-Get-The-Girl/123/2014-08-27T10</url>
    </EventSeries>
  </events>
</GetEventsResponse>

application/rss+xml

Sample:

<rss xmlns:a10="http://www.w3.org/2005/Atom" version="2.0">
  <channel>
    <title>CitySpark RSS Feed</title>
    <description />
    <item>
      <guid isPermaLink="false">123</guid>
      <link>http://www.yoursite.com/events/details/Save-The-World-Get-The-Girl/123/2014-08-27T10</link>
      <category>Performing Arts</category>
      <category>Music</category>
      <title>Save The World Get The Girl &amp; Wired for Havoc &amp; Paper Guns &amp; Star-Off</title>
      <description>&lt;img src="https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.large.png" alt="" /&gt; &lt;br /&gt;SOMA PRESENTS: SAVE THE WORLD GET THE GIRL WIRED FOR HAVOC PAPER GUNS all ages 7pm $7 at 24tix.com</description>
      <pubDate>Sat, 29 Jun 2024 09:31:23 Z</pubDate>
      <a10:updated>2024-06-29T09:31:23Z</a10:updated>
    </item>
  </channel>
</rss>

application/atom+xml

Sample:

<feed xmlns="http://www.w3.org/2005/Atom">
  <title type="text">CitySpark RSS Feed</title>
  <id>uuid:851cca6b-b003-4bce-bc67-f8ce3289a26d;id=1</id>
  <updated>2024-07-01T20:23:32Z</updated>
  <entry>
    <id>123</id>
    <title type="text">Save The World Get The Girl &amp; Wired for Havoc &amp; Paper Guns &amp; Star-Off</title>
    <published>2024-06-29T09:31:23Z</published>
    <updated>2024-06-29T09:31:23Z</updated>
    <link rel="alternate" href="http://www.yoursite.com/events/details/Save-The-World-Get-The-Girl/123/2014-08-27T10" />
    <category term="Performing Arts" />
    <category term="Music" />
    <content type="text">&lt;img src="https://citysparkstorage.blob.core.windows.net/portalimages/portalimages/4a49e1e0-a5ec-4df1-a2cb-7458a6c40f13.large.png" alt="" /&gt; &lt;br /&gt;SOMA PRESENTS: SAVE THE WORLD GET THE GIRL WIRED FOR HAVOC PAPER GUNS all ages 7pm $7 at 24tix.com</content>
  </entry>
</feed>