Find a Contact by Email Address or Reference Source and ID

GET {{baseUrl}}/api/Contact/Find?email=<string>&referenceSource=<string>&referenceId=<string>

Either email addres or reference source and id are required. Providing both will prioritize the reference source and id.

Request Params

KeyDatatypeRequiredDescription
emailstringThe email address.
referenceSourcestringThe reference source. Examples: Stripe, MailChimp, Shopify
referenceIdstringThe reference identifier that belongs to the reference source.

RESPONSES

status: OK

{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;contactType&quot;:&quot;\u003cstring\u003e&quot;,&quot;isPrivate&quot;:&quot;\u003cboolean\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;informalName&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;website&quot;:&quot;\u003cstring\u003e&quot;,&quot;maritalStatus&quot;:&quot;\u003cstring\u003e&quot;,&quot;anniversaryMonth&quot;:&quot;\u003cinteger\u003e&quot;,&quot;anniversaryDay&quot;:&quot;\u003cinteger\u003e&quot;,&quot;anniversaryYear&quot;:&quot;\u003cinteger\u003e&quot;,&quot;mergedIntoContactId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;address&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;label&quot;:&quot;\u003cstring\u003e&quot;,&quot;address1&quot;:&quot;\u003cstring\u003e&quot;,&quot;address2&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;postal&quot;:&quot;\u003cstring\u003e&quot;,&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;startMonth&quot;:&quot;\u003cinteger\u003e&quot;,&quot;startDay&quot;:&quot;\u003cinteger\u003e&quot;,&quot;endMonth&quot;:&quot;\u003cinteger\u003e&quot;,&quot;endDay&quot;:&quot;\u003cinteger\u003e&quot;},&quot;giftAskAmount&quot;:&quot;\u003cstring\u003e&quot;,&quot;giftAskType&quot;:&quot;\u003cstring\u003e&quot;,&quot;lifeToDateGiving&quot;:&quot;\u003cstring\u003e&quot;,&quot;yearToDateGiving&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastGiftAmount&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastGiftDate&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactIndividuals&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;contactId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;prefix&quot;:&quot;\u003cstring\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;middleName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;suffix&quot;:&quot;\u003cstring\u003e&quot;,&quot;gender&quot;:&quot;\u003cstring\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isSecondary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBeSecondary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;birthMonth&quot;:&quot;\u003cinteger\u003e&quot;,&quot;birthDay&quot;:&quot;\u003cinteger\u003e&quot;,&quot;birthYear&quot;:&quot;\u003cinteger\u003e&quot;,&quot;birthDate&quot;:&quot;\u003cstring\u003e&quot;,&quot;approximateAge&quot;:&quot;\u003cinteger\u003e&quot;,&quot;isDeceased&quot;:&quot;\u003cboolean\u003e&quot;,&quot;passion&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatarUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactMethods&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;isOptedIn&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;isOptedIn&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;createDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;modifiedDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;customFields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;}],&quot;customCollections&quot;:[{&quot;customCollectionId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;customCollectionName&quot;:&quot;\u003cstring\u003e&quot;,&quot;collectionInstanceId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}]},{&quot;customCollectionId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;customCollectionName&quot;:&quot;\u003cstring\u003e&quot;,&quot;collectionInstanceId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}]}]},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;contactId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;prefix&quot;:&quot;\u003cstring\u003e&quot;,&quot;firstName&quot;:&quot;\u003cstring\u003e&quot;,&quot;middleName&quot;:&quot;\u003cstring\u003e&quot;,&quot;lastName&quot;:&quot;\u003cstring\u003e&quot;,&quot;suffix&quot;:&quot;\u003cstring\u003e&quot;,&quot;gender&quot;:&quot;\u003cstring\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isSecondary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBeSecondary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;birthMonth&quot;:&quot;\u003cinteger\u003e&quot;,&quot;birthDay&quot;:&quot;\u003cinteger\u003e&quot;,&quot;birthYear&quot;:&quot;\u003cinteger\u003e&quot;,&quot;birthDate&quot;:&quot;\u003cstring\u003e&quot;,&quot;approximateAge&quot;:&quot;\u003cinteger\u003e&quot;,&quot;isDeceased&quot;:&quot;\u003cboolean\u003e&quot;,&quot;passion&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatarUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactMethods&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;isOptedIn&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;isOptedIn&quot;:&quot;\u003cboolean\u003e&quot;,&quot;isPrimary&quot;:&quot;\u003cboolean\u003e&quot;,&quot;canBePrimary&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;createDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;modifiedDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;customFields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;}],&quot;customCollections&quot;:[{&quot;customCollectionId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;customCollectionName&quot;:&quot;\u003cstring\u003e&quot;,&quot;collectionInstanceId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}]},{&quot;customCollectionId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;customCollectionName&quot;:&quot;\u003cstring\u003e&quot;,&quot;collectionInstanceId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}]}]}],&quot;contactGiftsUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactPassthroughGiftsUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactPlannedGiftsUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactRecurringGiftsUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactImportantNotesUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactNotesUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactTagsUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactRelationshipsUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;primaryAvatarUrl&quot;:&quot;\u003cstring\u003e&quot;,&quot;contactReferences&quot;:[{&quot;source&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;},{&quot;source&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;}],&quot;originSegmentId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;originSegment&quot;:&quot;\u003cstring\u003e&quot;,&quot;createDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;createdByUser&quot;:&quot;\u003cstring\u003e&quot;,&quot;modifiedDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;modifiedByUser&quot;:&quot;\u003cstring\u003e&quot;,&quot;tags&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;organizationGroups&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;customFields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;}],&quot;customCollections&quot;:[{&quot;customCollectionId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;customCollectionName&quot;:&quot;\u003cstring\u003e&quot;,&quot;collectionInstanceId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}]},{&quot;customCollectionId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;customCollectionName&quot;:&quot;\u003cstring\u003e&quot;,&quot;collectionInstanceId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;fields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}]}]}