Sickening Events Public API
by sickeningevents

Sickening Events Public API

Operations
Get Access Token
POST /v2/oauth/token
List of Events
GET /v2/events
Event Details
GET /v2/event/{id_or_slug}
Orders
GET /v2/orders/{event_id}
Order Details
GET /v2/order/{order_id}
Ticket Checkin IDs
GET /v2/tickets/checkin_ids/{event_id}
Get Access Token
POST /v2/oauth/token

This method gets your temporary access_token that you’ll need for all other API calls. Note: This MUST be POST (unlike the other API calls). After a few minutes, this access_token will expire, and a new one will need to be retrieved for any additional calls.

Request parameters

grant_type
string required

This must be set to “client_credentials”. There are no other options.

Example:
client_credentials
client_id
string required

Generate your client_id on the Sickening Events platform

Example:
YOUR_CLIENT_ID
client_secret
string required

Generate your client_secret on the Sickening Events platform

Example:
YOUR_CLIENT_SECRET

Responses

200 200

OK

Body
Object
access_token
string
Example:
e9876xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc1f4
expires_in
integer
Example:
3600
token_type
string
Example:
bearer
scope
unknown
refresh_token
string
Example:
d39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx91ff
List of Events
GET /v2/events

Get a list of all events you own. This data is not only sortable, but can be filtered by a large number of optional parameters. All date/time options should be UTC.

Request parameters

access_token
string required

This must be a valid access_token within its expiration limits.

partner_id
string optional

Including this ID will limit the result set to the specific partner.

organization_id
string optional

Including this ID will limit the result set to the specific organization.

start_after
string optional

Only retrieve events that start AFTER the specified UTC date (format: YYYY-MM-DD).

start_before
string optional

Only retrieve events that start BEFORE the specified UTC date (format: YYYY-MM-DD).

start_phrase
string optional

A string representing the date to pull events that start __. Possible values are: today, yesterday, tomorrow, this_week, this_weekend, next_week, next_weekend, this_month, next_month

end_after
string optional

Only retrieve events that end AFTER the specified UTC date (format: YYYY-MM-DD).

end_before
string optional

Only retrieve events that end BEFORE the specified UTC date (format: YYYY-MM-DD).

created_after
string optional

Only retrieve events that were created AFTER the specified UTC date (format: YYYY-MM-DD).

created_before
string optional

Only retrieve events that were created BEFORE the specified UTC date (format: YYYY-MM-DD).

active_only
boolean optional

Leaving this as true will restrict retrieved events to only ‘active’ events. Setting to false will allow the retrieval of both active and inactive events.

Default:
true
inactive_only
boolean optional

Setting to true will restrict retrieved events to only ‘inactive’ events.

Default:
false
privacy_type
string optional

By default, this will restrict events to only those that are public. Changing to ‘all’ will remove all restriction, or changing to ‘unlisted’ will make it only pull those events that are set to unlisted.

Default:
public
sort_by
string optional

Which field to sort by. By default (‘date’), will sort events by their start date. Other options are ‘name’ (event name) or ‘city’ (the city where the event is located).

Default:
date
sort_dir
string optional

Which direction you’d like to sort - either ascending (‘asc’ - the default) or descending (‘desc’).

Default:
asc
include_performers
string optional

Returns any associated performers/artists with an event

Default:
false

Responses

200 200

OK

Body
Object
Event
Object
active
boolean
Example:
true
address
string
Example:
1234 Happy St
address2
string
Example:
Apt B.
city
string
Example:
San Diego
country
string
Example:
United States
created
string

The date/time when the event was created (UTC). YYYY-MM-DD HH:MM:SS

Example:
2016-01-01 16:30:32
show_start
boolean

Whether to show the starting time of an event.

Example:
true
show_end
boolean

Whether to show the ending time of an event.

Example:
true
end
string

End date/time based on the event’s timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-28 20:00:00
end_utc
string

End date/time based on UTC timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-29 04:00:00
id
string
Example:
547xxxxx-xxxx-xxxx-xxxx-xxxxxxxx778
latitude
string

The float value of the latitude of the event.

Example:
33.394299
locale
string

A 3-character string of the language of the event (currently only support “eng”).

Example:
eng
location
string

Name of the event location / venue

Example:
The Joyful Theatre
longitude
string

The float value of the longitude of the event.

Example:
-111.598045
map_zoom
string

An integer representing how far in the Google Map should be zoomed.

Example:
13
modified
string

The date/time of the last time the event was modified. YYYY-MM-DD HH:MM:SS

Example:
2016-01-01 18:45:12
name
string

The name of the event.

Example:
Example Event
online_only
boolean

If true, the event has no physical location associated with it.

Example:
false
organization_id
string

Organization ID of the organization that owns this event

Example:
565xxxxx-xxxx-xxxx-xxxx-xxxxxxxx128
postal_code
string
Example:
12345
privacy_type
string

0 = public, 1 = unlisted, 2 = password protected, 3 = discoverable

Example:
0
region
unknown

Often used to replace “state” for non US events.

slug
string
Example:
example-event
start
string

Start date/time based on the event’s timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-28 18:00:00
start_utc
string

Start date/time based on UTC timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-29 02:00:00
state
string

Can be the full state “California” or the 2-character code “CA”

Example:
CA
tickets_active
boolean

Whether or not any tickets should be for sale.

Example:
true
timezone
string

The event’s timezone.

Example:
America/Los_Angeles
website
string

If provided. May or may not include the https://

Example:
https://www.example-event.com
event_topic_id
string
Example:
445xxxxx-xxxx-xxxx-xxxx-xxxxxxxx554
event_topic
string
Example:
Outdoors, Camping & Hiking
event_type_id
string
Example:
987xxxxx-xxxx-xxxx-xxxx-xxxxxxxx789
event_type
string
Example:
Trade Show
event_url
string
Example:
https://www.example-event.com/e/an-event
tickets_url
string
Example:
https://www.example-event.com/e/an-event/tickets
Logo
Object
url
string

Full path of the event logo

Example:
https://cd2cafd.ssl.cf5.rackcdn.com/6fc4165cb768be302d2ec387a058f81e_sm.png
show more
Event Details
GET /v2/event/{id_or_slug}

Get the details of a specific event. Replace {id_or_slug} with the ID or slug of the event you’d like the details on. Note: This API call is cached for 1 hour.

Path variables

id_or_slug
string required

Event ID or Event Slug

Request parameters

access_token
string required

This must be a valid access_token within its expiration limits.

photos
integer optional

Whether or not to return the event’s photo gallery records.

Default:
0
include_performers
string optional

Returns any associated performers/artists with the event.

Default:
false

Responses

200 200

OK

Body
Object
Event
Object
active
boolean

Whether or not the event is active.

Example:
true
address
string
Example:
1234 Happy St
address2
string
city
string
Example:
San Diego
country
string
Example:
United States
show_start
boolean

Whether to show the starting time of an event.

Example:
true
show_end
boolean

Whether to show the ending time of an event.

Example:
true
end
string

End date/time based on the event’s timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-28 20:00:00
end_utc
string

End date/time based on UTC timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-29 04:00:00
id
string

36-character string event id

Example:
547xxxxx-xxxx-xxxx-xxxx-xxxxxxxx778
latitude
string

The float value of the latitude of the event.

Example:
33.394299
locale
string

A 3-character string of the language of the event (currently only support “eng”).

Example:
eng
location
string
Example:
The Joyful Theatre
longitude
string

The float value of the longitude of the event.

Example:
-111.598045
map_zoom
string

An integer representing how far in the Google Map should be zoomed.

Example:
13
name
string

The name of the event.

Example:
Example Event
online_only
boolean

If true, the event has no physical location associated with it.

organization_id
string

Organization ID of the organization that owns this event

Example:
565xxxxx-xxxx-xxxx-xxxx-xxxxxxxx128
postal_code
string
Example:
12345
privacy_type
string

0 = public, 1 = unlisted, 2 = password protected, 3 = discoverable

Example:
0
region
unknown

Often used to replace “state” for non US events.

slug
string
Example:
example-event
start
string

Start date/time based on the event’s timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-28 18:00:00
start_utc
string

Start date/time based on UTC timezone. YYYY-MM-DD HH:MM:SS

Example:
2016-11-29 02:00:00
state
string

Can be the full state “California” or the 2-character code “CA”

Example:
CA
tickets_active
boolean

Whether or not any tickets should be for sale.

Example:
true
timezone
string

The event’s timezone.

Example:
America/Los_Angeles
website
string

May or may not include the https://

Example:
http://www.example-event.com
summary
string

The event summary stripped of HTML.

Example:
This event is going to be awesome.
description
string

The event description stripped of HTML.

summary_html
string

The event summary including any HTML.

Example:
<p>This event is going to be awesome.</p>
description_html
string

The event description including any HTML.

order_count
integer
Example:
640
ticket_count
integer

Number of non-refunded/voided tickets sold.

Example:
8
event_topic_id
string
Example:
445xxxxx-xxxx-xxxx-xxxx-xxxxxxxx554
event_topic
string
Example:
Outdoors, Camping & Hiking
event_type_id
string
Example:
987xxxxx-xxxx-xxxx-xxxx-xxxxxxxx789
event_type
string
Example:
Trade Show
event_url
string
Example:
https://www.example-event.com/e/an-event
tickets_url
string
Example:
https://www.example-event.com/e/an-event/tickets
Logo
Object
url
string

Full path of the event logo

Example:
https://cd2cafd.ssl.cf5.rackcdn.com/6fc4165cb768be302d2ec387a058f81e_sm.png
show more
Orders
GET /v2/orders/{event_id}

Retrieves orders from a specified event with additional parameters to change sort, date range, and other filters. Replace {event_id} with the ID of the event you’d like the orders from. All date/time options should be UTC.

Path variables

event_id
string required

ID of the event

Request parameters

access_token
string required

This must be a valid access_token within its expiration limits.

per_page
integer optional

How many results to retrieve (per page). Max 500.

Default:
100
page
integer optional

Which page to return. For example, if per_page is 20, and page is 3, the results would show 41-60.

Default:
1
q
string optional

Exact email address or last name attached to an order.

return_questionnaires
boolean optional

Whether or not to return the question responses from questionnaires (will include attendee responses as well IF tickets are returned)

Default:
false
return_tickets
boolean optional

Whether or not to return the tickets for each order as well.

Default:
false
return_line_item_fees
boolean optional

Whether or not to return the itemized line item fees for each order (if they exist).

Default:
false
ordered_after
string optional

Only retrieve orders that were ordered AFTER the specified date/time (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

ordered_before
string optional

Only retrieve orders that were ordered BEFORE the specified date/time (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

ordered_phrase
string optional

A string representing the date to pull orders created ___. Possible values are: today, yesterday, tomorrow, this_week, this_weekend, next_week, next_weekend, this_month, next_month

modified_after
string optional

Only retrieve orders that were modified AFTER the specified date/time (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

modified_before
string optional

Only retrieve orders that were modified BEFORE the specified date/time (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

sort_by
string optional

Which field to sort by. By default (‘date’), this will sort orders by their ordered date. Or ‘name’ to order by last name.

Default:
'date'
sort_dir
string optional

Which direction you’d like to sort - either ascending (‘asc’ - the default) or descending (‘desc’).

Default:
'asc'
total_above
number optional

Return only orders who’s order total is greater than this value.

Default:
0
total_below
string optional

Return only orders who’s order total is lesss than this value.

promo_used_only
boolean optional

If set to true, this will return only orders who used a promo code.

Default:
false

Responses

200 200

OK

Body
Object
Order
Object
id
string
Example:
547xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx778
status
string
Example:
1
first_name
string
Example:
Bill
last_name
string
Example:
Smith
email
string
Example:
johndoe@gmail.com
phone
string
Example:
5551239876
title
string
Example:
President
company
string
Example:
Apple
address
string
Example:
1234 Happy Ln
address2
string
Example:
Apt. B
city
string
Example:
Chicago
state
string
Example:
IL
postal_code
string
Example:
12345
country
string
Example:
US
opted_in
boolean
opted_in_sms
boolean
Example:
true
total_paid
string
Example:
14.70
refund_amount
string
Example:
0.00
taxes
string
Example:
0.70
contributions
string
Example:
2.00
service_charges
string
Example:
2.00
cc_fees
string
Example:
0.33
admin_charges
string
Example:
1.67
ticket_count
string
Example:
2
promo_code
unknown
promo_code_amount
string
Example:
0.00
promo_code_id
unknown
purchase_location
string
paid_date
string
Example:
2016-11-23 06:28:11
paid_date_utc
string
Example:
2016-11-23 14:28:11
affiliate_code
string
Example:
groupon
event_id
string
Example:
5471eea9-0bf8-4d1e-ab14-313e0ad0a778
delivery_method
string
Example:
email
show more
Order Details
GET /v2/order/{order_id}

Retrieves the details of a specified order as well as its tickets. Replace {order_id} with the ID of the specific order you’d like to retrieve.

Path variables

order_id
string required

Request parameters

access_token
string required

This must be a valid access_token within its expiration limits.

Responses

200 200

OK

Body
Object
Order
Object
id
string
Example:
547xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx778
status
string
Example:
1
first_name
string
Example:
Bill
last_name
string
Example:
Smith
email
string
Example:
johndoe@gmail.com
phone
string
Example:
5551239876
title
string
Example:
President
company
string
Example:
Apple
address
string
Example:
1234 Happy Ln
address2
string
Example:
Apt. B
city
string
Example:
Chicago
state
string
Example:
IL
postal_code
string
Example:
12345
country
string
Example:
US
opted_in
boolean
opted_in_sms
boolean
Example:
true
total_paid
string
Example:
14.70
refund_amount
string
Example:
0.00
taxes
string
Example:
0.70
contributions
string
Example:
2.00
service_charges
string
Example:
2.00
cc_fees
string
Example:
0.33
admin_charges
string
Example:
1.67
ticket_count
string
Example:
2
promo_code
unknown
promo_code_amount
string
Example:
0.00
promo_code_id
unknown
purchase_location
string
paid_date
string
Example:
2016-11-23 06:28:11
paid_date_utc
string
Example:
2016-11-23 14:28:11
affiliate_code
string
Example:
groupon
event_id
string
Example:
5471eea9-0bf8-4d1e-ab14-313e0ad0a778
delivery_method
string
Example:
email
Ticket
Array
Object
ticket_type_name
string
Example:
Free ticket
ticket_type_id
string
Example:
547xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx778
ticket_type_price
string
Example:
0.00
name
unknown
price
string
Example:
0.00
redeemed
boolean
promo_code
string
Example:
0
promo_code_id
unknown
show more
Ticket Checkin IDs
GET /v2/tickets/checkin_ids/{event_id}

Retrieves ticket check-in IDs from a specified event. Replace {event_id} with the ID of the event you’d like the ticket ids from.

Path variables

event_id
string required

ID of event

Request parameters

access_token
string required

This must be a valid access_token within its expiration limits.

per_page
integer optional

How many results to retrieve (per page). Max 5000.

page
integer optional

Which page to return. For example, if per_page is 20, and page is 3, the results would show 41-60.

Default:
1

Responses

500 default

default response