Highrise API

Users

The users API is currently just for reading, not writing.

Self

GET /me.xml

Return information about the currently authenticated user. Note that this endpoint may be requested using a username and password, rather than the API token. This is to allow applications to obtain the token from those credentials, rather than requiring their users to enter an obscure API token by hand.

Response

Status: 200 OK

<user>
  <id type="integer">1</id>
  <name>John Doe</name>
  <email-address>john.doe@example.com</email-address>
  <token>#{api_token}</token>
  <dropbox>#{dropbox_email_address}</dropbox>
  <created-at type="datetime">2007-04-23T20:25:29Z</created-at>
  <updated-at type="datetime">2007-04-23T20:25:29Z</updated-at>
</user>

Show

GET /users/#{id}.xml

Returns a single user.

Response

Status: 200 OK

<user>
  <id type="integer">1</id>
  <name>John Doe</name>
  <email-address>john.doe@example.com</email-address>
  <created-at type="datetime">2007-04-23T20:25:29Z</created-at>
  <updated-at type="datetime">2007-04-23T20:25:29Z</updated-at>
</user>

List All

GET /users.xml

Returns a collection of users.

Response

Status: 200 OK

<users>
  <user>
    ...
  </user>
  <user>
    ...
  </user>
</users>