Bantam Live

The Bantam Live API is a RESTful, JSON interface for accessing data within a Bantam Live account. We've designed the interface to be simple and easy to interact with and we'll be exposing more application features over time. See the "Support and Feedback" section below to ask us any questions or provide any feedback regarding our API. Thanks.

Getting started

To use the API, you'll need enable access by logging in to your Bantam Live account and visiting the 'API Access' section from the 'Settings' area.

Authentication

Authentication is handled using HTTP authentication over an SSL connection using your Bantam Live account credentials and the unique URL for your account. You will need to pass these credentials with each request. See the "Usage" section below for some examples of how this works.

Usage

Initially we have exposed the ability to read, create, update and delete contact records via the API. (More to come soon. Also see "Activity Stream" section below: the activity stream data is available to read via an authenticated RSS feed.) Simply use the api namespace to access contact data. Here are some examples using curl to show you how it works:

List contacts

• Method: GET /api/contacts
• Example: curl -H "Accept: application/json" -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts"
• Notes: Returns all people and companies available to the authenticated user

List contacts: people

• Method: GET /api/contacts?view=people
• Example: curl -H "Accept: application/json" -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts?view=people"
• Notes: Returns all people available to the authenticated user

List contacts: companies

• Method: GET /api/contacts?view=companies
• Example: curl -H "Accept: application/json" -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts?view=companies"
• Notes: Returns all companies available to the authenticated user

Read a contact record

• Method: GET /api/contacts/<id>
• Example: curl -H "Accept: application/json" -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts/4"
• Notes: Returns the contact with the id specified

Create a new contact record

• Method: POST /api/contacts
• Body: Initial contact data
• Example: curl -H "Content-Type: application/json"-X POST -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts" -d '{"first_name": "Tom", "last_name":"Jones", "type":"Person", "tag_names":"singer,vegas"}'
• Notes: application/json content-type and accept headers must be included. The JSON data keys map to the fields within the interface. When in doubt, simply read from a record that has the key you are trying to add. You must pass the type value to indicate if the contact is a person ( Person ) or a company ( Organization ).

Updating a contact record

• Method: PUT /api/contacts/<id>
• Body: JSON data with field updates
• Example: curl -H "Content-Type: application/json" -H "Accept: application/json" -X POST -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts/4" -d '{"last_name":"McJones"}'
• Notes: application/json content-type and accept headers must be included. The JSON data keys map to the fields within the interface. When in doubt, simply read from a record that has the key you are trying to update. You may only update contacts the authenticated user is allowed to update.

Deleting a contact record

• Method: DELETE /api/contacts/<id>
• Example: curl -H "Accept: application/json" -X DELETE -s "https://me%40example.com:mypassword@myaccount.bantamlive.com/api/contacts/4"
• Notes: application/json accept header must be included. You may only delete contacts the authenticated user is allowed to delete.

Activity Stream

The dashboard activity stream is available to each user through an authenticated RSS feed. To obtain the feed address, visit your account and click on the 'Subscribe' link at the bottom of the stream (usually at the bottom of the page). We will be exposing this activity through the JSON API soon.

Support and Feedback

If you have any questions about the Bantam Live API or would like to provide us with some feedback about things that aren't working for you or features you would like to see, please submit a support request in the "Help" section of the Bantam Live application when you are logged in. We look forward to building out our API based on your feedback.