INPUT_OBJECT

ContactFilterInput

Filter conditions for Contact records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input ContactFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [ContactFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [ContactFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: ContactFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Street address of the contact.
  • address: EntityFilterStringField
  • # City of the contact address.
  • city: EntityFilterStringField
  • # Free-form notes describing the contact.
  • comments: EntityFilterStringField
  • # Id of the contact type assigned to this contact.
  • contactTypeId: EntityFilterStringField
  • # Country of the contact address.
  • country: EntityFilterStringField
  • # Id of the currency exchange rate list applied to this contact.
  • currencyExchangeRatesListId: EntityFilterStringField
  • # Primary email address of the contact. Used as default recipient for emails sent
  • # from Coevera.
  • email1: EntityFilterStringField
  • # Additional email address.
  • email2: EntityFilterStringField
  • # Additional email address.
  • email3: EntityFilterStringField
  • # Additional email address.
  • email4: EntityFilterStringField
  • # Additional email address.
  • email5: EntityFilterStringField
  • # Given name of the contact.
  • firstName: EntityFilterStringField
  • # Gender of the contact: Unknown when not specified, Male, Female or NonBinary.
  • gender: GenderEnumFilterInput
  • # True when the contact has been archived. Archived contacts remain readable but
  • # are hidden from active lists and cannot be edited until reactivated.
  • isArchived: Boolean
  • # Family name of the contact.
  • lastName: EntityFilterStringField
  • # Middle name of the contact, if applicable.
  • middleName: EntityFilterStringField
  • # Id of the contact owner.
  • ownerId: EntityFilterStringField
  • # Primary phone number of the contact. Used as default target for click-to-call.
  • phone1: EntityFilterStringField
  • # Additional phone number.
  • phone2: EntityFilterStringField
  • # Additional phone number.
  • phone3: EntityFilterStringField
  • # Additional phone number.
  • phone4: EntityFilterStringField
  • # Additional phone number.
  • phone5: EntityFilterStringField
  • # Id of the profile picture document.
  • pictureId: EntityFilterStringField
  • # Job title or position of the contact.
  • position: EntityFilterStringField
  • # Free-text company name used when the contact is not linked to an actual Account
  • # record. Lets integrators capture the company without creating a separate
  • # Account.
  • quickAccountName: EntityFilterStringField
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users). The matching sharingUnits /
  • # sharingClients lists control who is granted access.
  • shareMode: ShareModeEnumFilterInput
  • # State or province of the contact address.
  • stateProvince: EntityFilterStringField
  • # Honorific or salutation prefix (e.g. Mr., Ms., Dr.) shown before the name.
  • title: EntityFilterStringField
  • # Id of the sales unit.
  • unitId: EntityFilterStringField
  • # ZIP or postal code of the contact address.
  • zipCode: EntityFilterStringField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Number of email sequences this record is currently actively enrolled in
  • # (soft-deleted or ended enrollments are not counted).
  • enrolledEmailSequences: Int
  • # External identifier of the record in the linked third-party service (e.g.
  • # Google, Microsoft 365, Exchange). Maintained by the sync engine.
  • exchangeEntityId: String
  • # External identifier of the record in the linked third-party service (e.g.
  • # Google, Microsoft 365, Exchange). Maintained by the sync engine.
  • gapiEntityId: String
  • # External identifier of the record in the linked third-party service (e.g.
  • # Google, Microsoft 365, Exchange). Maintained by the sync engine.
  • o365EntityId: String
  • # Matches records related to at least one of the listed records.
  • relatedEntities: [EntityFilterRelatedField]
  • # Conditions on custom fields, each identified by its api name. All listed
  • # conditions must match.
  • withCustom: [CustomField!]
  • # Contact type that classifies this contact. Contact types are configurable per
  • # team space and drive which form, fields and pipelines apply. Matches records
  • # where a related record meets these conditions.
  • contactType: ContactTypeFilterInput
  • # Currency exchange rate list used to convert monetary fields linked to this
  • # contact. Empty to inherit the team space default. Matches records where a
  • # related record meets these conditions.
  • currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput
  • # Sales user who owns this contact. Matches records where a related record meets
  • # these conditions.
  • owner: ClientFilterInput
  • # Profile picture associated with the contact. Matches records where a related
  • # record meets these conditions.
  • picture: CloudObjectFilterInput
  • # Sales unit this contact is assigned to. Determines which team members can see
  • # the record under unit-based sharing. Matches records where a related record
  • # meets these conditions.
  • unit: SalesUnitFilterInput
  • # Social network profiles linked to this contact (e.g. LinkedIn, Facebook).
  • # Matches records where a related record meets these conditions.
  • socialMedia: ContactSocialRelationFilterInput
  • # Primary account this contact belongs to. Set automatically when the contact has
  • # an account relation marked as primary. Matches records where a related record
  • # meets these conditions.
  • primaryAccount: AccountFilterInput
  • # Accounts this contact is linked to. Each link records the role and position the
  • # contact has at the related account. Matches records where a related record meets
  • # these conditions.
  • accountRelations: ContactAccountRelationFilterInput
  • # Sales units that have been granted shared access to this contact. Editable only
  • # when shareMode allows unit sharing. Matches records where a related record meets
  • # these conditions.
  • sharingUnits: ContactSharingSalesUnitRelationFilterInput
  • # Users that have been granted shared access to this contact. Editable only when
  • # shareMode allows user sharing. Matches records where a related record meets
  • # these conditions.
  • sharingClients: ContactSharingClientRelationFilterInput
  • # Documents linked to this contact. Matches records where a related record meets
  • # these conditions.
  • documents: CloudObjectRelationFilterInput
  • # Tag labels applied to this contact. Matches records where a related record meets
  • # these conditions.
  • tags: TagRelationFilterInput
  • # Saved view profiles this contact currently matches. Matches records where a
  • # related record meets these conditions.
  • staticProfiles: ProfileRelationFilterInput
  • }

link Require by