You can easily retrieve a JSON array containing all the events you manage using the following GET request:

GET /api/v1/events.json?auth_token=YOUR_API_TOKEN

The response should have the following format:

// 200 OK 
[ 
  {   
  // The first event   
},  
 {
     // The second event   
} 
]

XML

GET /api/v1/events.xml?auth_token=YOUR_API_TOKEN

Response:

<!-- 200 OK -->
 <?xml version="1.0" encoding="UTF-8"?>
 <events type="array">
   <event>
     <!-- [...] -->
   </event> 
  <event> 
    <!-- [...] -->  
 </event>
 </events>

Retrieve a specific event

If you are interested in a specific event and know its ID, you can send a GET request. The API returns the JSON object representing that event.

JSON

GET /api/v1/events/{event_id}.json?auth_token=YOUR_API_TOKEN

Response:

// 200 OK
 {
   "_id": "{event_id}",
   "badge_complete_hook_url": null,
   "description": "Sheldon Cooper and Amy Farrah Fowler are throwing a celebration party for reaching their tenth watcher.",
   "end_date": "2012-11-22T05:00:00+00:00",
   "locale": "en",
   "mobinetwork_enabled": false,
   "organizer": "Sheldon Cooper",
   "plan": "pro",
   "start_date": "2012-11-22T03:00:00+00:00",
   "timezone": "Pacific Time (US & Canada)",
   "title": "Fun with Flags Party",
   "reply_to_email": "sheldon@cooper.org",
   "guest_count": 12,
   "check_in_count": 422 
}

XML

GET /api/v1/events/{event_id}.xml?auth_token=YOUR_API_TOKEN

Response:

<!-- 200 OK -->
 <event>
   <_id>{event_id}</_id> 
  <title>Fun with Flags Party</title> 
  <description>Sheldon Cooper and Amy Farrah Fowler are throwing a celebration party for reaching their tenth watcher.</description>
   <locale>en</locale>
   <organizer>Sheldon Cooper</organizer>
   <plan>pro</plan>
   <start-date type="datetime">2012-11-22T03:00:00Z</start-date>
   <end-date type="datetime">2012-11-22T05:00:00Z</end-date>
   <timezone>Pacific Time (US &amp; Canada)</timezone>
   <mobinetwork-enabled type="boolean">false</mobinetwork-enabled>
   <reply-to-email>sheldon@cooper.org</reply-to-email>
   <badge-complete-hook-url nil="true"/>
   <guest-count type="integer">12</guest-count> 
  <check-in-count type="integer">422</check-in-count>
 </event>

Update an event

You can also update an event's information.

JSON

PUT /api/v1/events/{event_id}.json?auth_token=YOUR_API_TOKEN Content-Type: application/json; charset=utf-8

  {
   // Fields that can be updated. Include only the fields you want to update.   "title": "Fun with Flags Party",
   "description": "Sheldon Cooper and Amy Farrah Fowler are throwing a celebration party for reaching their tenth watcher.",
   "locale": "en",
   "mobinetwork_enabled": false,
   "organizer": "Sheldon Cooper",
   "start_date": "2012-11-22T03:00:00+00:00",
   "end_date": "2012-11-22T05:00:00+00:00",
   "timezone": "Pacific Time (US & Canada)",
   "badge_complete_hook_url": "http://my.company.org/handle_mobicheckin_guest_created.json",
   "reply_to_email": "your.email@company.org" 
}

Response:

// 204 No Content

XML

PUT /api/v1/events/{event_id}.xml?auth_token=YOUR_API_TOKEN Content-Type: application/xml; charset=utf-8

  <event>
   <!-- Fields that can be updated. Include only the fields you want to update. -->
   <title>Fun with Flags Party</title>
   <description>Sheldon Cooper and Amy Farrah Fowler are throwing a celebration party for reaching their tenth watcher.</description>
   <locale>en</locale>
   <organizer>Sheldon Cooper</organizer>
   <plan>pro</plan>
   <start-date type="datetime">2012-11-22T03:00:00Z</start-date>
   <end-date type="datetime">2012-11-22T05:00:00Z</end-date>
   <timezone>Pacific Time (US &amp; Canada)</timezone>
   <mobinetwork-enabled type="boolean">false</mobinetwork-enabled>   <badge-complete-hook-url>http://my.company.org/handle_mobicheckin_guest_created.json</badge-complete-hook-url>
   <reply-to-email>your.email@company.org</reply-to-email>
 </event>

Response:

<!-- 204 No Content -->

Events

XML

Retrieve a specific event

JSON

XML

Update an event

JSON

XML