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.
- id
- Readonly integer — The unique ID of the contact.
- integration
- Optional boolean, default:
false
— The Integration field is a hidden checkbox that can be set totrue
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
: Telephoneemail
: Emailwebsite
: Website
- label
- Required enum — The Label of the contact details. Valid values are:
-
fax
: only fortelephone
general
: only for organizationtelephone
,email
andwebsite
home
: only for persontelephone
mobile
: only for persontelephone
personal
: only for personemail
andwebsite
service_desk
: only for organizationtelephone
,email
andwebsite
service_desk_fax
: only for organizationtelephone
work
: only for organizationtelephone
, and for persontelephone
,email
andwebsite
- uri
- Required string (max 255) — The telephone number, email address, etc.