Ticketleap Public API

Organization Events List

Last Updated: .

List of all events belonging to the organization with ORG_SLUG as its slug. Does not include performance information for each event - see next two actions to get performance data.

URL

http://public-api.ticketleap.com/organizations/ORG_SLUG/events?key=PUT_API_KEY_HERE

URL Keys

The Organization Events List method url contains the following keys:

API Key

All requests must include your personal API key in the query string. To obtain an API key, login to your account on Ticketleap. Go to your account on the top bar, then select "API Key" from the menu.

Paging

The Organization Events List method accepts optional paging parameters in the query string. If these parameters are not included, the default values are used.

To return the second page of 5, the request would look like this: http://public-api.ticketleap.com/organizations/ORG_SLUG/events?key=PUT_API_KEY_HERE&page_num=2&page_size=5

Filtering by Date

The Organization Events List method accepts optional date filter parameters in the query string. Dates must be in the format YYYY-MM-DDTHHMM or YYYY-MM-DD. Date filtering is based on UTC time. If included only performances that meet the date criteria will be returned.

To filter the Organization Events List method between March and July of 2011, the request would look like this: http://public-api.ticketleap.com/organizations/ORG_SLUG/events?key=PUT_API_KEY_HERE&dates_after=2011-03-01&dates_before=2011-07-01

Filtering by Event Category Options

The Organization Events List method accepts optional event category option parameters in the query string. The option ids must be a bar delimited list of the GUID(s) for each option by which to filter. If included the events returned will be filtered exclusively by category and inclusively by option.

To filter the Organization Events List method by two event category options, the request would look like this: http://public-api.ticketleap.com/organizations/ORG_SLUG/events?key=PUT_API_KEY_HERE&event_filters=EVENT_FILTER_OPTION_ID1|EVENT_FILTER_OPTION_ID2

Sorting

The Organization Events List method can be sorted by specifying an optional parameter.

By specifying a value of date you ensure that the result will be sorted by the start time of the earliest performance after applying the date filter.

Specifying a value of alpha will sort the result set by the event name.

To sort the Organization Events List method by the earliest performance date, the request would look like this: http://public-api.ticketleap.com/organizations/ORG_SLUG/events?key=PUT_API_KEY_HERE&sort_by=date

Lists of Objects

The Organization Events List method returns a list of objects and will include the following fields in the response:

Example

Try an example of the Organization Events List method: http://public-api.ticketleap.com/organizations/puppies/events?key=PUT_API_KEY_HERE