1. Contacts
  2. Model

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. Also added as the first alternate name 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
alternate_names.0 string
Alternate name 1, which is also the nickname
alternate_names.1 string
Alternate name 2
alternate_names.2 string
Alternate name 3
alternate_names.3 string
Alternate name 4
alternate_names.4 string
Alternate name 5

Contact Addresses

All addresses associated with a contact must be unique. The address/primary address and all alternate addresses must be distinct from each other; duplicate addresses are not allowed.

address Address
The address for this contact.

primary_address Address | null
The primary address for this contact and it is same as the address field.

secondary_address Address | null
The secondary address for this contact.

addresses Array.<[Address](/apis/addresses/model)>
An array of all addresses associated with this contact.

alternate_addresses object

Show Details
alternate_addresses.secondary string
The first alternate address, which is also the secondary address
alternate_addresses.secondary_line2 string
Line2 for the first alternate address
alternate_addresses.home string
alternate_addresses.home_line2 string
alternate_addresses.work string
alternate_addresses.work_line2 string
alternate_addresses.education string
alternate_addresses.education_line2 string
alternate_addresses.other string
alternate_addresses.other_line string

Contact Emails

The primary email is required before adding alternate emails. All email fields (primary email and all alternate emails) must be unique and distinct from each other; duplicate email addresses are not allowed for a contact.

alternate_emails object

Show Details
alternate_emails.personal string
Alternate personal email
alternate_emails.education string
Alternate education email
alternate_emails.work string
Alternate work email
alternate_emails.social string
Alternate social email
alternate_emails.other string
Alternate other email

Contact Phone

The primary phone number is required before adding alternate phone numbers. All phone fields (primary phone and all alternate phones) must be unique and distinct from each other; duplicate phone numbers are not allowed for a contact.

alternate_phones object

Show Details
alternate_phones.mobile string
Alternate mobile phone
alternate_phones.education string
Alternate education phone
alternate_phones.work string
Alternate work phone
alternate_phones.home string
Alternate home phone
alternate_phones.other string
Alternate other phone

_search object | null
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
_search.id string
The ID of the contact.
_search.type string
The type of contact.
_search.name string
The contact's name. It will also match common nicknames.
_search.email string
The contact's email.
_search.phone string
The contact's phone.
_search.formatted_address string
The contact's full address string.
_search.relevance_score ?number
A number from 0 - 1 about how relevant the result was to the search query, with 1 being a perfect match.

_searchV2 object | null
A special property that will be included if searching through contacts. This is the result of the new advanced search.

Show Details
_searchV2.scores Scores
An object representing the various scores calculated
_searchV2.contact object
This is a subset of the contact model that will only include those properties where there is some matched content 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.

_outbound_trackers object | null
A special property that will be included if outbound trackers are available for this contact.

_inbound_trackers object | null
A special property that will be included if inbound trackers are available for this contact.

_experimental object
Experimental features and data associated with this contact.

Show Details
_experimental.rules Array
An array of experimental rules applied to this contact

Previous <- Contacts Overview
Next Events ->