Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Searches the entire dialogportal™ database for accounts that matches a given search string.
Endpoint ID:1011
Method:POST
URL:

/user/search/{contract-id}

 

 contract-id

Identifies the type of entities to search for and the contract fields to return. If omitted, all entity types are searched, each type returned using the default contract fields for that type.

Request body:

JSON data with search settings

Required fields  
 searchForThe string to search for in the database
Optional fields  
 offsetThe offset in search results from where to return data. If omitted, offset is set to zero
 limitThe maximum number of entities to return. It is not possible to return more than 50 entities per request, and if omitted, limit is set to 50
Example 1 – Search for “John Doe”:
{
	"searchFor": "John Doe"
}
Example 2 – Search for “John Doe” with an offset of 40 and return no more than 20 entities:
{
	"searchFor": "John Doe",
	"offset": 40,
	"limit": 20
}
Response body: 
Status codes:  
  • No labels