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
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: | JSON data with an array of the found entities. The result will also contain an object with properties that specify number of entities returned, the offset and whether there are more entities than the ones returned. Example 1 – Search for “John Doe” with a limit of one: { "entities": [ { "dpKey": 12345, "name": "John Doe" } ], "paging": { "offset": 0, "count": 1, "more": true } } Example 2 – Search for “Doe” without limit: { "entities": [ { "dpKey": 12345, "name": "John Doe" }, { "dpKey": 67890, "name": "Johnny Doe" } ], "paging": { "offset": 0, "count": 2, "more": false } } | ||||||||||||||||
Status codes: | 200 | One or more entities were found | |||||||||||||||
404 | No entities were found |