BatchBook API

Lists

BatchBook Lists are broken into two functionalities. The first is an index of all lists in the application. The show for each list will show you the contact id and name for every person on the list.

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

Show

GET /service/lists/#{id}.xml
Returns the contents of a single List.

Response

    
      Status: 200
      
      <list>
        <id type="integer">2</id>
        <title>Great people to know list</title>
        <description>A listing of all the cool people in the tech room.</description>
        <contacts>
          <contact>
            <id type="integer">15</id>
            <name>Alex Taylor</name>
            <type>Individual</type>
          </contact>
          <contact>
            <id type="integer">12</id>
            <name>Sean Ransom</name>
            <type>Individual</type>
          </contact>
          <contact>
            <id type="integer">14</id>
            <name>Adam Tucker</name>
            <type>Individual</type>
          </contact>
        </contacts>
      </list>

List All

GET /service/lists.xml
Returns the listing of all lists.

Parameters

Option Default Comment
offset 0
limit None

Response

    
      Status: 200
      
      <lists type="array">
        <list>
          <id type="integer">68895</id>
          <name>Import 03/19/2010</name>
          <description>Auto-generated list of imported records on 03/19/2010</description>
          <num_records>22</num_records>
        </list>
        <list>
          <id type="integer">12443</id>
          <name>Subject matter experts</name>
          <description>List of subjects BatchBlue staff are exploring</description>
          <num_records>20</num_records>
        </list>
        <list>
          ...
        </list>
        <list>
          ...
        </list>
      </lists>