Contacts API

Contacts are aggregated within people and organizations .

Collection Fields

By default the following fields will appear in collections of contacts:

protocol label uri

Obtain a different set of fields using the ?fields= parameter .

Sorting

Collections of contacts are sorted ascending by protocol then ascending by label .

Fields

contactable

Required reference to Person or Organization — The entity to contact.

Readonly integer — The unique ID of the contact.

integration

Optional boolean , default: false — The Integration field is a hidden checkbox that can be set to true using this API or the Import functionality. When checked, the contact is displayed as read-only in the user interface to prevent users from updating it.

protocol

Required enum — The protocol of the contact details. Valid values are:

telephone : Telephone
email : Email
website : Website

label

Required enum — The Label of the contact details. Valid values are:

fax : only for telephone
general : only for organization telephone , email and website
home : only for person telephone
mobile : only for person telephone
personal : only for person email and website
service_desk : only for organization telephone , email and website
service_desk_fax : only for organization telephone
work : only for organization telephone , and for person telephone , email and website

uri

Required string (max 255) — The telephone number, email address, etc.