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

Users

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

List All

GET /service/users.xml
For ease of use, BatchBook now allows a user to query a list of users. The list is filtered by permissions the same way the web application does it. Basic users are only shown themselves.

Note: The user making the request will see their name as "Me". This is the same as the drop down lists on the web application.

Response

    
      Status: 200

      <users type="array">
        <user>
          <email>bob@example.com</email>
          <name>Bob Smith</name>
        </user>
        <user>
          <email>joe@example.com</email>
          <name>Joe Harrington</name>
        </user>
        <user>
          <email>eric@example.com</email>
          <name>Me</name>
        </user>
      </users>