Highrise API

Tags

The tags API allows you to add, update, and delete tags from parties (people and companies), cases, and deals. In the documentation below, the generic "#{subject_type}" text must be replaced in practice with either "people", "companies", "kases", or "deals", and "#{subject_id}" should be the id of the subject (person, company, case or deal) that you want to manipulate or query the tags for.

List All

GET /tags.xml

Return all tags used in the account.

Response

Status: 200 OK

<tags type="array">
  <tag>
    <id type="integer"></id>
    <name></name>
  </tag>
  ...
</tags>

List Subject

GET /#{subject_type}/#{subject_id}/tags.xml

Return the tags on a person, company, case, or deal.

Response

Status: 200 OK

<tags type="array">
  <tag>
    <id type="integer"></id>
    <name></name>
  </tag>
  ...
</tags>

List parties

GET /tags/#{id}.xml

Return all parties (people and companies) associated with a given tag. Note, though, that this will not include deals and cases for that tag.

Response

Status: 200 OK

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

Add tag

POST /#{subject_type}/#{subject_id}/tags.xml

Adds a tag to a person, company, deal, or case.

Request

<name>#{name}</name>

Response

Status: 201 Created
Location: /tags/#{new_id}.xml

<tag>
  <id type="integer"></id>
  <name></name>
</tag>

Remove tag

DELETE /#{subject_type}/#{subject_id}/tags/#{id}.xml

Removes a tag from a person, company, deal, or case.

Response

Status: 200 OK