Skip to main content

Interface: CompanySearchInput

Defined in: type/CompanySearchInput.ts:9

Input object for CompanySearchInput

Properties​

addressActive?​

optional addressActive?: YesNo

Defined in: type/CompanySearchInput.ts:41

Search by active address

addressIsDefault?​

optional addressIsDefault?: YesNo

Defined in: type/CompanySearchInput.ts:39

Search by default address

addressTypes?​

optional addressTypes?: AddressType[]

Defined in: type/CompanySearchInput.ts:37

Search by address types

companyAttributeCreatedAt?​

optional companyAttributeCreatedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:23

Search by attribute date created

companyAttributeLastModifiedAt?​

optional companyAttributeLastModifiedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:25

Search by attribute date changed

companyCreatedAt?​

optional companyCreatedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:19

Search by company date created

companyLastModifiedAt?​

optional companyLastModifiedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:21

Search by company date changed

contactAttributeCreatedAt?​

optional contactAttributeCreatedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:33

Search by contact attribute date created

contactAttributeLastModifiedAt?​

optional contactAttributeLastModifiedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:35

Search by contact attribute date changed

contactCreatedAt?​

optional contactCreatedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:27

Search by contact date created

contactDateOfBirth?​

optional contactDateOfBirth?: DateSearchInput

Defined in: type/CompanySearchInput.ts:31

Search by contact date of birth

contactLastModifiedAt?​

optional contactLastModifiedAt?: DateSearchInput

Defined in: type/CompanySearchInput.ts:29

Search by contact date changed

offset​

offset: number

Defined in: type/CompanySearchInput.ts:13

Pagination offset number [default=12]

page​

page: number

Defined in: type/CompanySearchInput.ts:11

Pagination page number [default=1]

sortInputs?​

optional sortInputs?: CompanySearchSortInput[]

Defined in: type/CompanySearchInput.ts:44

Inputs to sort by! NOTE: Defaults to [{ field: RELEVANCE, order: DESC }] if not provided.

term?​

optional term?: string

Defined in: type/CompanySearchInput.ts:15

Company search term

termFields?​

optional termFields?: CompanyTermFieldInput[]

Defined in: type/CompanySearchInput.ts:17

List of fields to apply in term search. Defaults to [{ boost: 1, fieldNames: ALL_AVAILABLE_TERM_FIELDS }] if not provided.