Addressable Search Parameters


Addressable search parameters

Name Type Description

only_users

[Boolean]

Only search for users or do not search users only_users=true. The user profile information is also included in the results.

where

[String]

seperate by comma if you want to filter multiple fields

When order_by mru is selected, only employment and status can be included

Additional search fields where=[filters], current filters are supported:

-obj_type=[object type] → filter on object type (Person,Organisation,X1Object,UnknownAddressable)

include

[String]
seperate by comma if you want to include multiple fields

Include fields to the result. include=[included fields].
When order_by mru is selected, only employment and status can be included.

-status → presence information (status/icon/busy)
-nrCommunicatons → number of communication items, always added when colleagues are requested

Only persons:
employment → show the first employment of a person, this is ignored when colleagues are requested
title → title of person
initials → name initials of person
givenName → given name
namePrefix → name prefix
familyName → family name
nameSuffix → name suffix
additionalNames → additional names
gender → the gender
communicationLanguage → communicaton language
dateOfBirth → date of birth
userProfile → potential user profile of this person

Only organisations:
fieldOfBusiness → field of business
btwNumber → btw number
kvkNumber → kvk number