Get Satisfaction Documentation

It's important to understand the intent behind the Satisfaction API before we get into the grisly details. This API seeks to expose every and all functions of http://getsatisfaction.com such that you could recreate the entirety of Satisfaction if you so desired. Taking that into account, this API will encompass a great deal of functionality, and will no doubt have missing pieces for some time and we would appreciate if you would report issues that you find.

Response Formats

Request made to the Satisfaction API can be responded to with two different formats: Mixed Atom/XHTML and JSON.

You can specify which response format you would like to use through either the Accept header, or appending a format extension onto the end of your request url.

Accept Header

You can choose your response format by adding an Accept header to each HTTP request you make against the API.

Format Extension

As an alternative to the Accept header, you can append a format extension onto each request against the API which will set the response format explicitly. Note: It is recommended that if you are using the Mixed HTML/ATOM response formats that you simply leave off the format extensions; the API will default to this format.

ATOM/XHTML

By default, the API responds with a combination of atom feeds and xhtml documents with microformatted data. Resources that logically map to Atom feeds and entries (topics, replies being two example) are encoded as such. Conversely, items that do not map to atom feeds and entries are rendered as XHTML documents with data embedded in them using microformats. For example, people and companies are modeled in the system as hCard entries.

JSON

As an alternative to XHTML and Atom content, you can also request that responses be returned in a JSON format. Each resource is represented in JSON using custom formats; No standard specification is used. It is recommended that you refer to each individual resource's documentation to find how it is represented in JSON.

Resources

Resources that are exposed through the API take the general form of either a list of items or individual item. For example the url /companies will return a list of companies, whereas /companies/4 will return the individual company whose ID is 4.

Additional Links

• Using OAuth -- Go here to view the relevant details for using oauth in the API