This API is deprecated.

We have launched a new version of Batchbook and it has its own API which can be found here.

Please do not develop new integrations agains this API! We are leaving it this documentation in place soley as a reference for developers supporting existing integrations with “Batchbook Classic.”

BatchBook API

Recent Activity

Batchbook logs all changes made to your data. The Activities/Recent request will now allow the API to have the same information as the "Recent Activity" widget on the dashboard.

Note: Each of these requests requires that you authenticate with a BatchBook account. This requires an account name and an API token. For more information on authentication, visit the API homepage.

Methods

Recent Activity

GET /service/activities/recent.xml
To retrieve all Recent Activity from a BatchBook account, send an HTTP GET request to the Activities services URL. BatchBook returns an XML representation of the Activity. The Record search is available if you want more information for the records referenced.

Parameters

Option Default Comment
page 1 Recent Activities are returned in groups of 10.

Response

    
      Status: 200

      <activity type="array">
        <name>Event Created</name>
        <description>Follow up on Sales Call</description>
        <record_type>To-Do</record_type>
        <record_id type="integer">72291</record_id>
        <user_name>Eric Krause</user_name>
        <user_id type="integer">17768</user_id>
        <date>2010-10-10 19:14:08 -0400</date>
      </activity>
      <activity>
        <name>Supertag Information Edited</name>
        <description></description>
        <record_type>Individual</record_type>
        <record_id type="integer">1</record_id>
        <user_name>Eric Krause</user_name>
        <user_id type="integer">17768</user_id>
        <date>2010-10-08 17:21:23 -0400</date>
      </activity>
      <activity>
        <name>New Record Created</name>
        <description>Bob Smith</description>
        <record_type>Individual</record_type>
        <record_id type="integer">70744</record_id>
        <user_name>Eric Krause</user_name>
        <user_id type="integer">17768</user_id>
        <date>2010-07-09 00:20:05 -0400</date>
      </activity>