Spongecell Developer API
Introducing our new REST API
We've built a new (and truly RESTful) API to replace our classic Developer API with a simpler and more complete way to access the power of the Spongecell.
The new REST API will grow to support all of our old formats (XML, CSV, HTML, iCalendar, JSON, and RSS), but we are starting out with support for XML only.
You can learn more about REST (Representational State Transfer) on Wikipedia.
Although there are a few parts of the API which are usable without being authenticated, most will require user authentication. Please read more about authentication to find out how it works.
In addition to this online reference, we also have some offline documents available on this page.
Resources
All of our resources share a similar API. As we continue to develop this new API, we will add additional resources, and fill in more actions on the current resources.
| Authorization Tokens | Authenticate to your Spongecell user account and manage your authorization tokens. | Help |
| Calendars | View public and permitted calendars. | Help |
| Comments | Create and manage comments for events. | Help |
| Contacts | Manage your contacts and import from other services. | Help |
| Events | View public and permitted events and modify permitted events. | Help |
| Invitations | Create and manage invitations for events. | Help |
| Reminders | Create and manage reminders for events. | Help |
| Responses | Create and update responses for events. | Help |
| Session | Authenticate to your Spongecell user account and manage user session. | Help |
| Users | View, modify, and create users. | Help |
| Widgets | View, modify, and create widgets for an authorized user. | Help |
Output Formats
Although we currently only support XML (and HTML through browser's inherent XML capabilities), we will support additional formats down the road. To specify which format you want the results displayed in, simply append .xml or .csv and the output will be rendered in that format. The default is html, so be sure to append .xml in your API calls.
Errors
In the case of any error, the API will return the error message in a single, root XML element named error_message containing the error message along with a failure response status code.
If there is no error, it will always return a success status code as well as XML elements depending on the exact call.