Skip to navigation

Get a contact

Returns a contact by ID.

Arguments

idStringRequired
The ID of the contact to return.

Returns

a Contact
contactAddresseslist of ContactAddresses
The contact's postal addresses.
contactCitizenshipslist of ContactCitizenships
The citizenships the contact holds.
contactClassificationslist of ContactClassifications
The links between the contact and its classifications.
contactDetailslist of ContactDetails
The contact's email addresses, phone numbers, and other contact methods.
contactOrganizationslist of ContactOrganizations
The contact's employment and affiliation history.
contactRoleslist of ContactRoles
The roles the contact holds.
createdAtString
The contact's creation date.
departmentContactslist of DepartmentContacts
The departments the contact belongs to.
idString
The contact's unique identifier.
inventionAgreementSignedBoolean
Whether the contact has signed an invention assignment agreement.
naiMemberBoolean
Whether the contact is a member of the National Academy of Inventors.
updatedAtString
The date the contact was last updated.
vaAffiliatedBoolean
Whether the contact is affiliated with the US Department of Veterans Affairs.
addressStateCodeStringOptional
The state code of the contact's primary address.
archivedAtStringOptional
The date the contact was archived. Returns null if the contact is active.
archivedByUserUserOptional
The user who archived the contact.
countryStringOptional
The country of the contact's primary address.
createdByUserUserOptional
The user who created the contact.
createdByUserIdStringOptional
The unique identifier of the user who created the contact.
degreeNameStringOptional
The contact's academic degree, such as PhD.
employeeIdStringOptional
The contact's employee identifier at the organization.
employmentStateEnumEmploymentStateEnumOptional
The contact's employment status.
Allowed values:
firstNameStringOptional
The contact's first name.
fullNameStringOptional
The contact's full name.
fullNameWithDegreeStringOptional
The contact's full name followed by their academic degree.
fullNameWithPreferredStringOptional
The contact's full name with the preferred name in parentheses.
fullNameWithPreferredAndDegreeStringOptional
The contact's full name with the preferred name and academic degree.
genderEnumContactGenderEnumOptional
The contact's gender.
Allowed values:
lastActivityAtStringOptional
The date of the most recent activity on the contact.
lastNameStringOptional
The contact's last name.
linkedinUrlStringOptional
The contact's LinkedIn profile URL.
locationStringOptional
The contact's location.
middleNameStringOptional
The contact's middle name.
photoUrlStringOptional
The URL of the contact's photo.
positionTitleStringOptional
The contact's job title.
preferredNameStringOptional
The name the contact prefers to be called.
stateEnumContactStateEnumOptional
The contact's state.
titleEnumContactTitleEnumOptional
The contact's honorific, such as Dr or Prof.
typeEnumContactTypeEnumOptional
The contact's type, such as internal or external.
Allowed values:
updatedByUserUserOptional
The user who last updated the contact.
updatedByUserIdStringOptional
The unique identifier of the user who last updated the contact.
userUserOptional
The user account linked to the contact, if any.
userIdStringOptional
The unique identifier of the user account linked to the contact.