Events
Event Search
Description
Returns a list of events.
Request
GET /events
- Query Parameters:
type
(EventSearchType)category
(EventCategory)date
(EventSearchDate)sortBy
(EventSearchSortBy)direction
(SortDirection)dateStart
(DateTime)dateEnd
(DateTime)q
(string): Timezone for search. Ex: US/Eastern, America/Los_Angelesname
(string): supports wildcard using%
charactersvenue
(string)city
(string)state
(string)country
(string)password
(string)omit
(string)ticketAgent
(Mapping)pageNumber
(int): The page number of the results. Defaults to 1.pageSize
(int): The page size of the results. Defaults to 1000 (Max is 5000).
Search Types
- Presale Date = 0
- Public Sale Date = 1
- Event Date = 2
- Presale or Public Sale Date = 4
- Post Sales Date = 5
- Presale or Post Sale Date = 14
- Just Added Events = 17
Category
- All = 0
- Concerts = 1
- Arts = 2
- Family = 3
- Sports = 4
- Misc = 5
Search Dates
- Today = 0
- Tomorrow = 1
- Yesterday = 2
- Future, including Today = 3
- Future = 19
- Next 3 Days = 7
- Next 7 Days = 8
- Next 10 Days = 9
- Next 2 Weeks = 10
- Next 30 Days = 11
- Past = 4
- Past 7 Days = 12
- Past 30 Days = 5
- Past 3 Months = 16
- Past 6 Months = 17
- Past Year = 18
- Specified Date* = 6
- Specified Date Range* = 13
- This Week = 14 (Sunday through Saturday)
*
mean you'll need to provide eventSearchSpecifiedDate
and/or eventSearchSpecifiedDateEnding
Sort Direction
- Ascending = 0
- Descending = 1
Sort By
- Presale Date = 0
- Public Sale Date = 1
- Event Date = 2
- Name = 3
- Venue = 4
- City = 5
- State = 6
- DateAdded = 8
Response
- Status Code: 200 OK
- Content Type: application/json
- Response Body: List of events.
- Possible Status Codes:
- 400 Bad Request: Returned if the request was not in the correct format.
- 404 Not Found: Returned if the events were not found.
Example
GET /events?type=1&name=%Hamilton%
Response:
{
"events": [
{
"id": "evt_12345",
"name": "Hamilton",
...
}
]
}