CompanySearchInput

Comprehensive search criteria for finding companies with advanced filtering options.

Provides powerful company discovery functionality including full-text search, date range filtering, address type filtering, and custom sorting. Supports pagination and relevance-based ranking for optimal search results.

input CompanySearchInput {
  page: Int!
  offset: Int!
  term: String
  termFields: [CompanyTermFieldInput!]
  companyCreatedAt: DateSearchInput
  companyLastModifiedAt: DateSearchInput
  companyAttributeCreatedAt: DateSearchInput
  companyAttributeLastModifiedAt: DateSearchInput
  contactCreatedAt: DateSearchInput
  contactLastModifiedAt: DateSearchInput
  contactDateOfBirth: DateSearchInput
  contactAttributeCreatedAt: DateSearchInput
  contactAttributeLastModifiedAt: DateSearchInput
  addressTypes: [AddressType!]
  addressIsDefault: YesNo
  addressActive: YesNo
  sortInputs: [CompanySearchSortInput!]
}

Fields

CompanySearchInput.page ● Int! non-null scalar

Page number for pagination.

Specifies which page of results to return. Must be 1 or greater. Default is page 1.

CompanySearchInput.offset ● Int! non-null scalar

Number of items per page.

Controls how many companies are returned in each page. Default is 12 companies per page.

CompanySearchInput.term ● String scalar

General search term for company discovery.

Searches across company names, contact information, addresses, and other searchable fields. Minimum 2 characters required for search performance.

CompanySearchInput.termFields ● [CompanyTermFieldInput!] list input

Specific fields to search within with custom boosting.

Allows targeting specific fields for the search term with custom relevance boosting. If not provided, searches all available fields with equal weight. Useful for prioritizing certain types of matches.

CompanySearchInput.companyCreatedAt ● DateSearchInput input

Filter by company creation date range.

Allows filtering companies based on when they were originally created in the system. Useful for finding recently added companies or companies from specific time periods.

CompanySearchInput.companyLastModifiedAt ● DateSearchInput input

Filter by company last modification date range.

Allows filtering companies based on when they were last updated. Useful for finding recently modified companies or tracking changes over time.

CompanySearchInput.companyAttributeCreatedAt ● DateSearchInput input

Filter by company attribute creation date range.

Allows filtering companies based on when their custom attributes were initially created. Useful for tracking attribute assignment patterns and data enrichment timelines.

CompanySearchInput.companyAttributeLastModifiedAt ● DateSearchInput input

Filter by company attribute modification date range.

Allows filtering companies based on when their custom attributes were last updated. Useful for finding companies with recently changed attribute values.

CompanySearchInput.contactCreatedAt ● DateSearchInput input

Filter by contact creation date range.

Allows filtering companies based on when their contacts were initially added to the system. Useful for tracking relationship establishment and contact acquisition patterns.

CompanySearchInput.contactLastModifiedAt ● DateSearchInput input

Filter by contact modification date range.

Allows filtering companies based on when their contact information was last updated. Useful for finding companies with recently updated contact details.

CompanySearchInput.contactDateOfBirth ● DateSearchInput input

Filter by contact date of birth range.

Allows filtering companies based on the birth dates of their associated contacts. Useful for demographic analysis and age-based business targeting.

CompanySearchInput.contactAttributeCreatedAt ● DateSearchInput input

Filter by contact attribute creation date range.

Allows filtering companies based on when custom attributes were assigned to their contacts. Useful for tracking contact data enrichment and attribute assignment patterns.

CompanySearchInput.contactAttributeLastModifiedAt ● DateSearchInput input

Filter by contact attribute modification date range.

Allows filtering companies based on when their contact attributes were last updated. Useful for finding companies with recently changed contact attribute values.

CompanySearchInput.addressTypes ● [AddressType!] list enum

Filter by specific address types.

Allows filtering companies that have addresses of the specified types. Array must contain unique values. Useful for targeting companies with specific address configurations like delivery or billing addresses.

CompanySearchInput.addressIsDefault ● YesNo enum

Filter by companies with default addresses.

Allows filtering companies based on whether they have addresses marked as default for their type. Useful for finding companies with properly configured primary addresses.

CompanySearchInput.addressActive ● YesNo enum

Filter by companies with active addresses.

Allows filtering companies based on whether they have active, usable addresses. Useful for finding companies with current, valid address information.

CompanySearchInput.sortInputs ● [CompanySearchSortInput!] list input

Sorting configuration for search results.

Array of sort criteria to apply to the search results. Array must contain unique values. If not provided, defaults to relevance-based sorting in descending order. Multiple sort criteria are applied in the order specified.

Member Of

companySearch query