Skip to main content

ContactFilterInput

Specifies the criteria to filter contact records with based on their event registrations. Optional.

input ContactFilterInput {
  country: String
  customFields: CustomFieldFilterInput
  eventCheckInStatus: EventCheckInStatus
  eventCheckedInDate: OpenEndedDateTimeRangeFilter
  externalIdentifier: String
  includeInactive: Boolean
  internalNumber: [PositiveInt!]
  lastModifiedAt: OpenEndedDateTimeRangeFilter
  lastName: StringRangeFilterInput
  marketingPrivacy: ContactMarketingPrivacyStatusFilter
  organization: StringRangeFilterInput
  postCode: String
  primaryEmail: String
  userDefinedField1: String
  userDefinedField2: String
  userDefinedField3: String
  userDefinedField4: String
}

Fields

`ContactFilterInput.country` ● `String` scalar

Filter contacts matching the specified primary address country. Optional.

Partial matching is supported. For example, a value of United will match United States, United Kingdom, United Arab Emirates and Tanzania, United Republic of.

`ContactFilterInput.customFields` ● `CustomFieldFilterInput` input

Filter contacts matching the specified custom field values. Optional.

`ContactFilterInput.eventCheckInStatus` ● `EventCheckInStatus` enum

Filter contacts based on their check-in status of the event. Optional.

`ContactFilterInput.eventCheckedInDate` ● `OpenEndedDateTimeRangeFilter` input

Filter contacts based on the date they checked into the event. Optional.

`ContactFilterInput.externalIdentifier` ● `String` scalar

Filter contacts matching the specified external identifier. Optional.

Note: only exact matches are supported.

`ContactFilterInput.includeInactive` ● `Boolean` scalar

Filter contacts based on their inactivity status. Optional.

When not specified, inactive contacts will not be returned.

`ContactFilterInput.internalNumber` ● `[PositiveInt!]` list scalar

Filter contacts whose internalNumber matches a number in the specified array. Optional.

`ContactFilterInput.lastModifiedAt` ● `OpenEndedDateTimeRangeFilter` input

Filter contacts whose details have been modified within the specified data and time range. Optional.

`ContactFilterInput.lastName` ● `StringRangeFilterInput` input

Filter contacts whose last name falls within the specified range. Optional.

`ContactFilterInput.marketingPrivacy` ● `ContactMarketingPrivacyStatusFilter` input

Filter contacts matching the specified marketing privacy status value. Optional.

`ContactFilterInput.organization` ● `StringRangeFilterInput` input

Filter contacts whose organization name falls within the specified range. Optional.

`ContactFilterInput.postCode` ● `String` scalar

Filter contacts matching the specified primary address postcode/zipcode. Optional.

Partial matching is supported. For example, a value of jack will match jackson@acme.com and someone@jackson.org

`ContactFilterInput.primaryEmail` ● `String` scalar

Filter contacts matching the specified primary email address. Optional.

Partial matching is supported. For example, a value of jack will match jackson@acme.com and someone@jackson.org

`ContactFilterInput.userDefinedField1` ● `String` scalar

Filter contacts matching the specified user defined field 1. Optional.

`ContactFilterInput.userDefinedField2` ● `String` scalar

Filter contacts matching the specified user defined field 2. Optional.

`ContactFilterInput.userDefinedField3` ● `String` scalar

Filter contacts matching the specified user defined field 3. Optional.

`ContactFilterInput.userDefinedField4` ● `String` scalar

Filter contacts matching the specified user defined field 4. Optional.

Member Of

CeContactStoreContactSearchFilterInput input ● ContactSearchFilterInput input ● ContactStoreContactSearchFilterInput input ● MembershipContactStoreContactSearchFilterInput input

Fields
Member Of