Highrise API

Parties

Search

GET /parties/search.xml?state=CA&zip=90210&custom_field=foobar&etc=...

Returns people and companies that match your search criteria. Search by any criteria you can on the Contacts tab, including custom fields. Combine criteria to narrow results.

Results are paged in groups of 25. Use ?n=25 to check for the next 25 results and so on.

Response

Status: 200 OK

<parties type="array">
  <party type="Person">
    ...
  </party>
  <party type="Company">
    ...
  </party>
</parties>

Recently Viewed

GET /parties/recently_viewed.xml

Returns the last 50 people and companies viewed.

Response

Status: 200 OK

<parties type="array">
  <party type="Person">
    ...
  </party>
  <party type="Company">
    ...
  </party>
</parties>

Deletions

GET /parties/deletions.xml?since=20070425154546

Returns deleted parties in order of deletion time, older to newer. Includes party type, id, and deletion time. Pass the optional ‘since’ query parameter to only return deletions since that time.

Response

Status: 200 OK

<deletions type="array">
  <deletion type="Person">
    <id type="integer">1</id>
    <deleted-at type="datetime">2007-08-27T03:11:52Z</deleted-at>
  </deletion>
  <deletion type="Company">
    <id type="integer">2</id>
    <deleted-at type="datetime">2008-03-12T14:37:13Z</deleted-at>
  </deletion>
  ...
</deletions>