Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchUsers

Execute a search through the users

Filtering is possible on all kinds of properties. By default the search results will be restricted to users in the current country.

Hierarchy

  • SearchUsers

Index

Properties

Properties

Optional AssignedEmployeeID

AssignedEmployeeID: undefined | number

Entity type: User

Optional CustomFields

CustomFields: undefined | {}

Optional Data

Data: undefined | {}

Optional DateOfBirth

DateOfBirth: undefined | string

Optional EmailAddress

EmailAddress: undefined | string

Optional EmployeeNumber

EmployeeNumber: undefined | string

Optional FiscalID

FiscalID: undefined | string

Optional IncludeAllCountries

IncludeAllCountries: undefined | false | true

By default the search will only return users from the same Country as the current OrganizationUnit. Optionally an extensive search can be performed by enabling this option. But keep in mind this will take some time in real production scenario's. It is advised to only show this option in the frontend after an intial search has been done in the current country.

Optional IncludeCustomers

IncludeCustomers: undefined | false | true

Optional IncludeEmployees

IncludeEmployees: undefined | false | true

Optional Name

Name: undefined | string

Optional PageConfig

PageConfig: PageConfig<{}>

Optional PhoneNumber

PhoneNumber: undefined | string

Optional PricingGroupID

PricingGroupID: undefined | string

Optional PrimaryOrganizationUnitID

PrimaryOrganizationUnitID: undefined | number

Entity type: OrganizationUnit

Optional RoleID

RoleID: undefined | number

Entity type: Role

Optional SearchQuery

SearchQuery: undefined | string

Optional SocialSecurityNumber

SocialSecurityNumber: undefined | string

Optional Types

Types: UserTypes

Optional UserIDs

UserIDs: number[]

Entity type: User

Optional VatNumber

VatNumber: undefined | string

Optional ZipCode

ZipCode: undefined | string