Events

These resources lists available events

GET /events

List all published events filtered by desired parameters

Request

Name Type Description
start_date string [Optional] Filters events to show only dates on or after start_date
Format: YYYY-MM-DD
end_date string [Optional] Filters events to show only dates on or before end_date
Format: YYYY-MM-DD
order string [Optional] Orders events by date either ascending (ASC) or descending (DESC)
Defaults to ASC
scope string [Optional] Dynamically filters events to only show scoped events
Supported scopes: upcoming, past. Note that past will return no associated event links in the response.
links string [Optional] Comma-separated list of case insensitive partially matchable names, that matches the links by name
schedule string [Optional] Filters the events by the link status
Supported schedules: current, upcoming and past. Use active to include both current and upcoming schedules.
limit integer [Optional] Limits the number of contests returned
page integer [Optional] Returns records for a given page
tags string [Optional] Include a list of comma-separated tags to filter events by
Ex. vip,presale will only show events that are tagged with vip OR presale

Assuming today is 3/30/2013, get all upcoming published events in April 2013 with the tag vip OR the tag presale, order by date descending. As the current date moves into and past April, more events will be filtered out as upcoming events will become past events.

{
    "start_date": "2013-04-01",
    "end_date": "2013-04-30",
    "order": "DESC",
    "scope": "upcoming",
    "tags": "vip,presale"
}

Responses

Success: For request above (customer is logged in)

{
    "status": "ok",
    "events": [
        {
            "id": 55,
            "title": "UFC 151",
            "date": "2013-04-16T00:00:00-0400",
            "start": "2013-04-16T19:00:00-0400",
            "description": "<p>The fight of the century!</p>",
            "doors_open": "2013-04-16T17:00:00-0400",
            "tags": ["presale"],
            "timezone": {
                "tz": "America/New_York",
                "short": "EDT",
                "long": "Eastern Time (US & Canada)",
                "offset": "-0400"
            },
            "venue": {
                "name": "Madison Square Garden",
                "address": "4 Pennsylvania Plaza",
                "city": "New York",
                "state": "NY",
                "postalcode": "10001",
                "country": "US",
                "country_name": "United States",
                "lat": "40.7504",
                "lon": "-73.994"
            },
            "links": [
                {
                    "name": "UFC VIP Tickets",
                    "status": "Show",
                    "exclusive": true,
                    "url": "http://www.ticketmaster.com/ufc_vip",
                    "host": "Ticketmaster",
                    "codes": [
                        "JAGKVYI4QQ",
                        "JAM8BO53U4"
                    ],
                    "code_instructions": "<p>Do not share your code with anyone.</p>\n",
                    "affiliate_id": 2,
                    "publish_start": null,
                    "publish_end": null
                },
                {
                    "name": "UFC Pre-Sale Tickets",
                    "status": "Show",
                    "exclusive": true,
                    "url": "http://www.ticketmaster.com/ufc_presale",
                    "host": "Ticketmaster",
                    "codes": [
                        "ufcIsAwesome"
                    ],
                    "code_instructions": "<p>Do not share your code with anyone.</p>\n",
                    "affiliate_id": null,
                    "publish_start": null,
                    "publish_end": null
                },
                {
                    "name": "UFC Public Sale",
                    "status": "Show On Specific Dates Only",
                    "exclusive": false,
                    "url": "http://www.ufc.com/tickets",
                    "host": "Ufc",
                    "codes": [],
                    "code_instructions": null,
                    "affiliate_id": null,
                    "publish_start": "2013-04-10T12:00:00-0400",
                    "publish_end": "2013-04-20T18:00:00-0400"
                }
            ],
            "contests": []
        },
        {
            "id": 25,
            "title": "UFC 150",
            "date": "2013-04-03T00:00:00-0400",
            "start": "2013-04-03T19:00:00-0400",
            "description": "<p>The pre-fight of the century!</p>",
            "timezone": "America/New_York",
            "doors_open": "2013-04-03T17:00:00-0400",
            "tags": ["presale"],
            "timezone": {
                "tz": "America/New_York",
                "short": "EDT",
                "long": "Eastern Time (US & Canada)",
                "offset": "-0400"
            },
            "venue": {
                "name": "Madison Square Garden",
                "address": "4 Pennsylvania Plaza",
                "city": "New York",
                "state": "NY",
                "postalcode": "10001",
                "country": "US",
                "country_name": "United States",
                "lat": "40.7504",
                "lon": "-73.994"
            },
            "links": [], // No ticketing links associated with this event
            "contests": [
                {
                    "id": 1,
                    "name": "First Contest"
                }
            ]
        }
    ],
    "pagination": {
        "current_page": 1,
        "total_pages": 2
    }
}

Success: scope=past

If scope=past is sent, no event links will be returned in the API response.

{
    "status": "ok",
    "events": [
        {
            "id": 55,
            "title": "UFC 151",
            "date": "2013-04-16T00:00:00-0400",
            "start": "2013-04-16T19:00:00-0400",
            "description": "<p>The fight of the century!</p>",
            "doors_open": "2013-04-16T17:00:00-0400",
            "tags": ["presale"],
            "timezone": {
                "tz": "America/New_York",
                "short": "EDT",
                "long": "Eastern Time (US & Canada)",
                "offset": "-0400"
            },
            "venue": {
                "name": "Madison Square Garden",
                "address": "4 Pennsylvania Plaza",
                "city": "New York",
                "state": "NY",
                "postalcode": "10001",
                "country": "US",
                "country_name": "United States",
                "lat": "40.7504",
                "lon": "-73.994"
            },
            "links": [],
            "contests": []
        },
        
    ],
    "pagination": {
        "current_page": 1,
        "total_pages": 1
    }
}

Success: No events found

{
    "status": "ok",
    "events": [],
    "pagination": {
        "current_page": 1,
        "total_pages": 0
    }
}

GET /events/{id}

List all details of a specific event

Request

Name Type Description
id url segment [Required] The ID of the specific event

No parameters required (besides your API key of course).

Responses

Success: After GET request to /events/55 (customer is logged in and has access to exclusive links)

{
    "status": "ok",
    "event": {
        "id": 55,
        "title": "UFC 151",
        "date": "2013-04-16T00:00:00-0400",
        "start": "2013-04-16T19:00:00-0400",
        "description": "<p>The fight of the century!</p>",
        "doors_open": "2013-04-16T17:00:00-0400",
        "tags": [],
        "timezone": {
            "tz": "America/New_York",
            "short": "EDT",
            "long": "Eastern Time (US & Canada)",
            "offset": "-0400"
        },
        "venue": {
            "name": "Madison Square Garden",
            "address": "4 Pennsylvania Plaza",
            "city": "New York",
            "state": "NY",
            "postalcode": "10001",
            "country": "US",
            "country_name": "United States",
            "lat": "40.7504",
            "lon": "-73.994"
        },
        "links": [
            {
                "name": "UFC VIP Tickets",
                "status": "Show",
                "exclusive": true,
                "url": "http://www.ticketmaster.com/ufc_vip",
                "host": "Ticketmaster",
                "codes": [
                    "JAGKVYI4QQ",
                    "JAM8BO53U4"
                ],
                "code_instructions": "<p>Do not share your code with anyone.</p>\n",
                "affiliate_id": 2,
                "publish_start": null,
                "publish_end": null
            },
            {
                "name": "UFC Pre-Sale Tickets",
                "status": "Show",
                "exclusive": true,
                "url": "http://www.ticketmaster.com/ufc_presale",
                "host": "Ticketmaster",
                "codes": [
                    "ufcIsAwesome"
                ],
                "code_instructions": "<p>Do not share your code with anyone.</p>\n",
                "affiliate_id": null,
                "publish_start": null,
                "publish_end": null
            },
            {
                "name": "UFC Public Sale",
                "status": "Show On Specific Dates Only",
                "exclusive": false,
                "url": "http://www.ufc.com/tickets",
                "host": "Ufc",
                "codes": [],
                "code_instructions": null,
                "affiliate_id": null,
                "publish_start": "2013-04-10T12:00:00-0400",
                "publish_end": "2013-04-20T18:00:00-0400"
            }
        ],
        "contests": []
    }
}

Success: After GET request to /events/55 (customer is logged out or doesn't have access to exclusive links)

Any exclusive codes will be hidden and exclusive link URLs will be replaced with the fanclub's plans URL.

{
    "status": "ok",
    "event": {
        "id": 55,
        "title": "UFC 151",
        "date": "2013-04-16T00:00:00-0400",
        "start": "2013-04-16T19:00:00-0400",
        "description": "<p>The fight of the century!</p>",
        "doors_open": "2013-04-16T17:00:00-0400",
        "tags": [],
        "timezone": {
            "tz": "America/New_York",
            "short": "EDT",
            "long": "Eastern Time (US & Canada)",
            "offset": "-0400"
        },
        "venue": {
            "name": "Madison Square Garden",
            "address": "4 Pennsylvania Plaza",
            "city": "New York",
            "state": "NY",
            "postalcode": "10001",
            "country": "US",
            "country_name": "United States",
            "lat": "40.7504",
            "lon": "-73.994"
        },
        "links": [
            {
                "name": "UFC VIP Tickets",
                "status": "Show",
                "exclusive": true,
                "url": "http://www.ufcfightclub.com/join",
                "host": "Ufcfightclub",
                "codes": [],
                "code_instructions": null,
                "affiliate_id": null,
                "publish_start": null,
                "publish_end": null
            },
            {
                "name": "UFC Pre-Sale Tickets",
                "status": "Show",
                "exclusive": true,
                "url": "http://www.ufcfightclub.com/join",
                "host": "Ufcfightclub",
                "codes": [],
                "code_instructions": null,
                "affiliate_id": null,
                "publish_start": null,
                "publish_end": null
            },
            {
                "name": "UFC Public Sale",
                "status": "Show On Specific Dates Only",
                "exclusive": false,
                "url": "http://www.ufc.com/tickets",
                "host": "Ufc",
                "codes": [],
                "code_instructions": null,
                "affiliate_id": null,
                "publish_start": "2013-04-10T12:00:00-0400",
                "publish_end": "2013-04-20T18:00:00-0400"
            }
        ],
        "contests": []
    }
}

Failure: Invalid event id

  {
      "status": "error",
      "messages": ["No event found"]
  }