API - Person Typeahead Search
PersonTypeahead search
Another search option is to use the typeahead search endpoint: http://securelb.trackerproducts.com/api/people/typeahead?search=mike
This endpoint will search the following fields:
- Alias
- Business Name
- Last Name
- First Name
- Middle Name
Here is an example of using this endpoint:
http://securelb.trackerproducts.com/api/people/typeahead?search=mike
will return an array of people along with a count of the people returned by the query in the following format:
{
"people": [
{
"id": 1634850,
"text": "Singleton, Mike (msingleton@trackerproducts.com)"
}
],
"peopleCountLimitExceeded": false
}
Here is an example of searching by email address:
http://securelb.trackerproducts.com/api/people/typeahead?search=tracker
which returns the following:
{
"people": [
{
"id": 1,
"text": "Sparrow, Jack (jsparrow@trackerproducts.com)"
},
{
"id": 3,
"text": "dawg - Tracker Muppets - Bear, Fozzy (fozzybear@made-up-email.com)"
},
{
"id": 1634850,
"text": "Singleton, Mike (msingleton@trackerproducts.com)"
},
{
"id": 1634867,
"text": "skyscraper - Tracker Software Developers - Ding, Bill (bricks@gmail.com)"
},
{
"id": 1640072,
"text": "Person, Example (exampleperson@trackerproducts.com)"
},
{
"id": 1634992,
"text": "b - Tracker Products - Taylor, Chuck
(chucktaylor@trackerproducts.com)"
}
],
"peopleCountLimitExceeded": false
}