Contacts
Model
Contact Model
The Contact model represents a contact entity with various attributes and associated names, addresses, emails, phones, and metadata.
Attributes
object "contact"
The description of the model.
id string
Unique identifier for the contact.
organization_id string
Unique identifier for the organization that owns this contact. This will always be your organization ID.
name string
The name of the contact.
nickname string
The nickname of the contact.
email string
The email for the contact.
id_number string
The id number for the contact.
phone string
The phone number for this contact.
groups Array.<{id:string; name:string; location_id:string}>
A list of groups IDs to which this contact is associated.
locations Array.<{name:string; id:string}>
A list of location IDs to which this contact is associated.
notes string
Any notes that were added about this contact.
created_at integer
Time in epoch seconds when this resource was created.
updated_at integer
Time in epoch seconds when this contact was last updated.
updated_by string
The ID of the user or key who last updated the contact.
metadata object
Additional Key value pairs associated with the contact.
checksum string
The checksum of the contact object.
alternate_names object
Show Details
address Address
The parsed address for this contact.
alternate_addresses object
Show Details
alternate_emails object
Show Details
alternate_phones object
Show Details
_search object
A special property that will be included if searching through contacts. This is a flat object which will include <mark> tags around characters that have matched the search. You can use this to more easily highlight text for a user interface.
Show Details
options object
The options passed into the request.