Contact

Show the details of a contact

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Contact Attributes

Attribute NameTypeDescriptionAttributes
selfreferenceURL of the ContactRead-only
Non-null
prefixstringPreferred salutation (e.g. "Mr.", "Ms.")Read-Write
Nullable
Searchable
first_namestringFirst nameRead-Write
Nullable
Searchable
middle_namestringMiddle name(s)Read-Write
Nullable
Searchable
last_namestringLast nameRead-Write
Nullable
Searchable
full_namestringFull composed nameRead-only
Nullable
Searchable
suffixstringName suffix (e.g. "Jr.", "PhD.")Read-Write
Nullable
Searchable
aliasstringLegal aliasRead-Write
Nullable
nicknamestringCasual nicknameRead-Write
Nullable
Searchable
birthdaydateBirth date, optionally including yearRead-Write
Nullable
anniversarydateAnniversary date, optionally including yearRead-Write
Nullable
flaggedbooleanIs the contact flaggedRead-Write
Nullable
taglinestringTagline for the contactRead-Write
Nullable
hobbiesstringContact's hobbiesRead-Write
Nullable
imagereferenceURL of Contact ImageRead-only
Nullable
categorystringCategory nameRead-Write
Nullable
keywordsarray of stringList of KeywordsRead-Write
Nullable
extra_fieldsarray of objectsList of Extra FieldsRead-Write
Nullable
emailsarray of emailList of E-mail addressesRead-Write
Nullable
Searchable
urlsarray of urlList of URLsRead-Write
Nullable
social_profilesarray of social_profileList of Social ProfilesRead-Write
Nullable
phone_numbersarray of phone_numberList of Phone NumbersRead-Write
Nullable
Searchable
addressesarray of addressesList of AddressesRead-Write
Nullable
Searchable
detailsstringAdditional misc. notes or details about the contactRead-Write
Nullable
companiesarray of companyrolesList of CompanyRolesRead-Write
Nullable
opportunitiesarray of opportunityrolesList of OpportunityRolesRead-Write
Nullable
projectsarray of projectList of ProjectsRead-Write
Nullable
contactsarray of contactList of ContactsRead-Write
Nullable
groupsarray of groupList of GroupsRead-Write
Nullable
tasksarray of taskList of TasksRead-Write
Nullable
formsarray of formList of FormsRead-Write
Nullable
ownerreferenceURL of the User that is responsible for the contactRead-Write
Non-null
Default value is creator
creatorreferenceURL of the User that created the contactRead-only
Non-null
trashedbooleanIs the Contact in the trashRead-only
Non-null
create_datedatetimeTimestamp from when the contact was createdRead-only
Non-null
modify_datedatetimeTimestamp from when the contact was last updatedRead-only
Non-null
👍

Aliases and Nicknames

In many regions, alias refers to an alternative legal name that can be used on legal documents in place of a persons original name.

On the other hand, nicknames are a casual alternative name with no legal weight.

🚧

Birthdays and Anniversaries

Birthdays and anniversaries are a special because some people prefer to keep the year secret, or they've forgotten, or perhaps for some other reason it is unimportant. In these cases, in order to maintain ISO8601 compatibility, we will use 0000 as the year to indicate that the year component is actually missing.

An example birthday on June 3rd, for an unknown year, would serialized as 0000-07-03.

📘

Contact Details

The details attribute is meant for short notes or details about a contact that don't fit into any other attribute. The field length is limited to 8000 characters.

Longer notes should be added as a Note and linked to the contact.

Path Params
int32
required

The contact identifier

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain