BatchBook API

Home > BatchBook API > Users

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

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.

    
      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>