Interface: ContactSearchArguments

Defined in: type/ContactSearchArguments.ts:8

Input object for ContactSearchArguments

Properties

contactIds?

optional contactIds?: number[]

Defined in: type/ContactSearchArguments.ts:10

List of unique contact ids

---

createdAt?

optional createdAt?: DateSearchInput

Defined in: type/ContactSearchArguments.ts:30

Search by date created

---

email?

optional email?: string

Defined in: type/ContactSearchArguments.ts:18

Contact's email

---

firstName?

optional firstName?: string

Defined in: type/ContactSearchArguments.ts:12

Contact's first name

---

gender?

optional gender?: Gender

Defined in: type/ContactSearchArguments.ts:20

Contact's gender

---

lastModifiedAt?

optional lastModifiedAt?: DateSearchInput

Defined in: type/ContactSearchArguments.ts:28

Search by date modified

---

lastName?

optional lastName?: string

Defined in: type/ContactSearchArguments.ts:16

Contact's last name

---

middleName?

optional middleName?: string

Defined in: type/ContactSearchArguments.ts:14

Contact's middle name

---

offset

offset: number

Defined in: type/ContactSearchArguments.ts:24

offset input field

---

page

page: number

Defined in: type/ContactSearchArguments.ts:22

page input field

---

sort?

optional sort?: ContactSortInput[]

Defined in: type/ContactSearchArguments.ts:26

List of contact sort filters

---

term?

optional term?: string

Defined in: type/ContactSearchArguments.ts:33

Free-text search term matched as a case-insensitive substring across the contact's own fields. The id field matches by exact id (numeric terms only). Restrict the searched fields with termFields. Multi-word terms must all match (AND). Each token must be at least 3 characters, or a numeric id.

---

termFields?

optional termFields?: ContactTermField[]

Defined in: type/ContactSearchArguments.ts:35

Fields the term searches. Text fields match by case-insensitive substring; the ID field matches by exact id (numeric terms only). When omitted, contact text fields are searched.