Guestlist is a hosted ticketing service. Use this gem to grab events data, ticket orders, and other swanky info from Guestlist's API.
I've been told that the Guestlist API itself is still under development, so consider this ample warning that things are unstable around here. You have been warned, young Will Robinson!
Add to your Gemfile and run the
bundle command to install it.
gem "guestlist", :git => "git://github.com/rocketscientist/guestlist.git"
If you're using Rails,
is a good place to put this:
Guestlist.configure do |config| config.username = 'firstname.lastname@example.org' config.password = 'super-duper-secret-word' end
Enabling API Access
Currently, the API is accessible when you ask for it. Submit a support ticket and thank them when API access is enabled for your account.
You can fetch data from events created through the Guestlist
admin panel. When you've created an event, make a note of the
You can find your
event_id from the API endpoint under the "API" tab in
Your endpoint will look something like
which means your
Return the event's name:
Guestlist.event('28374').name # => "Cheese Party"
Return the event's start/stop datetime and timezone:
Guestlist.event('28374').start # => "2012/04/01 01:30:00 +0000" Guestlist.event('28374').timezone # => "Eastern Time (US & Canada)"
Return the event's description:
Guestlist.event('28374').description # => "<p>This is going to be a great party. We've got lots of cheeses: cheddar, blue, havarti, and many more.</p>"
description method returns raw HTML.
These methods return total ticket counts across all ticket types:
Guestlist.event('28374').total_tickets_sold # => 6 Guestlist.event('28374').total_tickets_remaining # => 94 Guestlist.event('28374').total_tickets_quantity # => 100
There's an endpoint for retrieving orders for a given event. I haven't done anything with this so you're welcome to fork and send me a pull request.