Search the database people matching the query. Return a summary list of key data suitable for a directory view.
Get a list of the first 30 people who match the search term
Path parameters
-
Method to find the people
name: Persons Name id: infoodle profile unique id (the ID you see in their profile page) email: Email address phone: Personal phone number postcode: Post code country: Country hhname: Household or Organisation name hhid: House ID address: Full Address givenum: Giving number BA: Cheque number in transaction CC: Credit card number in transaction RF: Reference number in transaction
Values are
name
,email
,phone
,postcode
,country
,hhname
,hhid
,address
,givenum
,BA
,CC
, orRF
. -
The term being searched
GET
/people/directorysearch/{searchmethod}/{query}
curl \
-X GET https://YOURSITE.infoodle.com/apiv2/people/directorysearch/{searchmethod}/{query} \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"unique_id": 779,
"url": "https://demoinfoodle.infoodle.com/people?uniqueid=21",
"title": "Mr",
"firstname": "Dave",
"middlename": "string",
"lastname": "Trainer",
"organisationcontact": "N",
"gender": "Male",
"phone": [
{
"for": "PERSONAL",
"id": 456,
"type": "work",
"value": "012 123 1234"
}
],
"cell": [
{
"id": 456,
"type": "work",
"value": "012 123 1234"
}
],
"email": [
{
"id": 456,
"type": "work",
"value": "my@example.com",
"active": 1
}
],
"person_image": "iVBORw0KGgoAAAA......",
"last_updated_datetime_utc": "2022-05-17 03:09:58",
"lastUpdatedDatetimeUtcShowLocal": "17 May 2022 15:09"
}