API Documentation — version 1

• Overview
• Vendors
• Contracts
• Services
• Software
• Hardware
• Users
• Departments

Sample API URLs

To get all users:

https://{your-site}.vendorrisk.com/api/v1/users.xml?token={api_key}

XML output:

<users>
  <user>
    [see fields below]
  </user>
  <user>
    [see fields below]
  </user>
</users>

To get a specific user:

https://{your-site}.vendorrisk.com/api/v1/users/jdoe.xml?token={api_key}

XML output:

<user>
  <login>jdoe</login>
  <first_name>John</first_name>
  <last_name>Doe</last_name>
  <name>John Doe</last_name>
  <email>jdoe@example.com</email>
  <title>Risk Manager</title>
  <work_phone>123-456-7890</work_phone>
  <owner>Yes</owner>
  <admin>Yes</admin>
  <department>Information Technology</department>
  <login_count>25</login_count>
  <failed_login_count>0</failed_login_count>
  <last_request_at>1/31/2010 8:00 PM</last_request_at>
  <password_updated_at>1/12/2010 8:00 PM</password_updated_at>
  <created_at>11/30/2009 8:00 PM</created_at>
  <updated_at>1/13/2010 8:00 PM</updated_at>
</user>

Note: Unlike the other modules, there is not a permalink field in the XML output for Users. Instead, the login field is used to retrieve a specific user.