API Return Values Documentation

Ryan's Avatar


25 Jun, 2010 02:07 PM

It would be really helpful if you guys would document the return values from your API. Your documentation is pretty clear on the request URL and POST parameters, but no where does it give examples for or document what you will receive from the API call.

I'm currently working on some contribution to Mousetrap and it's difficult to know if the fields I get back will always be there. For instance, if an optional field is empty (null) will it return as "" in the API call or will the attribute not exist at all?

Something like this would be nice... http://developer.37signals.com/basecamp/companies.shtml


  1. Support Staff 1 Posted by Marc Guyer on 25 Jun, 2010 02:35 PM

    Marc Guyer's Avatar

    Agreed -- this has been on the wishlist for a while. However, there's nothing more to document than what can be seen within your own account. If you're looking at a customer in the GUI, you can simply replace the /admin/ with /xml/ and you'll get the single customer response XML for that customer. This is the response for each customers/whatever API call. We would have a hard time doing justice to all of the different possibilities for responses when you consider all of the pricing plan config differences and customer data options.

    That said, we do have plans to add some rudimentary response examples to the docs.

  2. Marc Guyer closed this discussion on 25 Jun, 2010 02:35 PM.

Discussions are closed to public comments.
If you need help with Cheddar please start a new discussion.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac

Recent Discussions

28 Mar, 2024 10:45 PM
24 Jan, 2024 08:33 AM
11 Jan, 2024 07:13 AM
30 Nov, 2023 02:07 AM
22 Nov, 2023 08:41 AM