This can be used to search for data records based on defined criteria, similar to the search in enterprise. The type of record searched for is specified in the resource identifier (
address, estate, searchcriteria
See Search estate for more information on searching for estates.
See Search search criteria for more information on searching for search criteria.
Contains the search term to search for. This must not be empty.
STRING. Mandatory for marketplace providers. Not relevant for all other users. To verify the user which uses the marketplace return the “apiClaim” parameter from the service call as “extendedclaim”. User rights are then observed by the marketplace provider API user (not applicable for search criteria).
Below only the parameters for “Search address” are explained.
OPTIONAL. Search includes secondary contact information (phone/email) rather than just the main information
OPTIONAL. Search is case-sensitive
OPTIONAL. Array of fields to include in the search
OPTIONAL. Maximum number of records returned
OPTIONAL. STRING. Field to sort by. The field names from the administration must be used. Here
OPTIONAL. STRING. Possible values:
DESC. Ascending or descending
First name in the address record
Last name in the address record
Company in the address record
Primary email address in the address record