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
prefixstringSalutation, e.g. "Mr." or "Dr." (max 128 characters)Read-Write
Nullable
Searchable
individual_salutationstringHow to address the contact in letters, e.g. "Dear John" (max 512 characters)Read-Write
Nullable
first_namestringFirst name (max 256 characters)Read-Write
Nullable
Searchable
middle_namestringMiddle name(s) (max 256 characters)Read-Write
Nullable
Searchable
last_namestringLast name (max 256 characters)Read-Write
Nullable
Searchable
full_namestringFirst, middle and last name joined with spacesRead-only
Nullable
Searchable
suffixstringName suffix, e.g. "Jr." or "PhD" (max 64 characters)Read-Write
Nullable
Searchable
aliasstringLegal alias (max 512 characters)Read-Write
Nullable
Searchable
nicknamestringCasual nickname (max 256 characters)Read-Write
Nullable
Searchable
birthdaydateBirthday, optionally without a year (see below)Read-Write
Nullable
Searchable
anniversarydateAnniversary, optionally without a year (see below)Read-Write
Nullable
Searchable
flaggedbooleanWhether the contact is flaggedRead-Write
Non-null
Searchable
taglinestringTagline (max 512 characters)Read-Write
Nullable
Searchable
hobbiesstringHobbies (max 1024 characters)Read-Write
Nullable
imagereferenceURL of the Contact Image. Only present when the contact has an imageRead-only
Nullable
Searchable
categorystringCategory nameRead-Write
Nullable
Searchable
keywordsarray of stringList of Keywords (max 64)Read-Write
Nullable
Searchable
extra_fieldsobjectExtra (custom) field values, keyed by field identifier. See Extra FieldsRead-Write
Nullable
Searchable
emailsarray of emailList of Email addresses. Searched as email_addressesRead-Write
Nullable
Searchable
urlsarray of urlList of URLsRead-Write
Nullable
Searchable
social_profilesarray of social_profileList of Social ProfilesRead-Write
Nullable
Searchable
phone_numbersarray of phone_numberList of Phone NumbersRead-Write
Nullable
Searchable
addressesarray of addressList of AddressesRead-Write
Nullable
Searchable
detailsstringShort notes about the contact (max 8000 characters)Read-Write
Nullable
companiesarray of company rolesCompanies the contact works for, with company, title, department, role and defaultRead-Write
Nullable
Searchable
opportunitiesarray of opportunity rolesOpportunities the contact is involved in, with opportunity, title and roleRead-Write
Nullable
Searchable
projectsarray of project rolesProjects the contact is involved in, with project, title and roleRead-Write
Nullable
Searchable
contactsarray of relationshipRelated contacts, with contact, relationship_type and direction. See RelationshipsRead-Write
Nullable
appointmentsarray of linkLinked AppointmentsRead-Write
Nullable
Searchable
groupsarray of linkLinked GroupsRead-Write
Nullable
Searchable
notesarray of linkLinked NotesRead-Write
Nullable
Searchable
tasksarray of linkLinked TasksRead-Write
Nullable
Searchable
formsarray of linkLinked FormsRead-Write
Nullable
Searchable
userreferenceThe User whose own contact record this is. Only present for users' contactsRead-only
Nullable
Searchable
ownerreferenceURL of the User responsible for the contactRead-Write
Non-null
Default value is the user making the request
Searchable
creatorreferenceURL of the User that created the contactRead-only
Non-null
Searchable
trashedbooleanWhether the contact is in the trash. Set to false to restore itRead-only
Non-null
create_datedatetimeWhen the contact was createdRead-only
Non-null
Searchable
modify_datedatetimeWhen the contact was last updatedRead-only
Non-null
Searchable
👍

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 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 be serialized as 0000-06-03. Send dates in the same YYYY-MM-DD format; send null to clear them.

Extra Fields

extra_fields holds the values of the contact's custom fields. Contacts have 12 text fields and 4 date fields. Each is keyed by its default identifier, even if the field has been renamed in Daylite, and only fields with a value are returned:

"extra_fields": {
  "com.marketcircle.daylite/extra1": { "value": "Gold", "display_name": "Membership" },
  "com.marketcircle.daylite/extra_date_1": { "value": "2025-03-07T18:00:04.000Z", "display_name": "Renewal Date" }
}

display_name is the field's current name and is read-only. When creating or updating a contact, send only the value. Fields you leave out keep their current value, and sending null or {} clears all of them.

📘

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 ID

Query Params
boolean

Return a smaller version of the record that leaves out lists and linked records.

Responses

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