Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListQuery

Hierarchy

  • ListQuery

Index

Properties

Optional page

page: number

Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'

Optional perPage

perPage: number

Indicates the page size (number of items). If not specified, the value is '100' by default

Optional phoneNumber

phoneNumber: string[]

Optional sortBy

sortBy: ("FirstName" | "LastName" | "Company")[]

Sorts results by the specified property. The default is 'First Name'

Optional startsWith

startsWith: string

If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive

Generated using TypeDoc