BatchBook API

Home > BatchBook API

Introduction

The BatchBook API is an XML REST interface for accessing your account. We have a Ruby library to make this process easy but provide examples here with curl.

• Authentication
• Services
• Libraries & Sample Code
• Developers Forum

Authentication

The BatchBook API uses a token-based system of authentication. Your BatchBook API Token can be found (and reset) in the sidebar of the Sync tab in BatchBook. Authenticate all your API calls with HTTP Basic Authentication, using your API token as the username, and any dummy password (such as ‘x’ in the example below).

The code to do this will depending on the tools you're using, but for example, you could use curl to authenticate and request a list of the people in your account, like so:

curl -u your_token:x -X GET https://your_account.batchbook.com/service/people.xml

Services

• Home
• Contacts
  • People
  • Companies
• Communications
• SuperTags
• To-Dos

Libraries & Sample Code

We currently have a Ruby library which implements all of the API methods.

Looking for sample code in other langages? Tell us: what programming language(s) are you using?

Developers Forum

Visit our Developers Forum with any questions or feedback you have. We'd also love to hear about what you're building with the BatchBook API.