Search the database people matching the query. Return a summary list of key data suitable for a directory view.

GET /people/directorysearch/{searchmethod}/{query}
oauthSecurity

Get a list of the first 30 people who match the search term

Path parameters

  • searchmethod string Required

    Method to find the people

    name: Persons Name 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, or RF.

  • query string Required

    The term being searched

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • unique_id string
    • url string
    • title string
    • firstname string
    • middlename string
    • lastname string
    • organisationcontact string

      Values are Y or N.

    • gender string

      Values are Male, Female, or ORGANISATION.

    • phone array[object]
      Hide phone attributes Show phone attributes object
      • for string

        Wether this is for the organisation/household or the individual

        Values are PERSONAL or ORGANISATION.

      • id integer

        The ID of this phone number record

      • type string

        The word used to describe this phone number

      • value string

        Phone number as entered by the user

    • cell array[object]
      Hide cell attributes Show cell attributes object
      • id integer

        The ID of this cell phone record

      • type string

        The word used to describe this cell phone number

      • value string

        Phone number as entered by the user

    • email array[object]
      Hide email attributes Show email attributes object
      • id integer

        The ID of this email address record

      • type string

        The word used to describe this email address

      • value string

        Email address as entered by the user

      • active integer

        Whether this email address is active or not

        Values are 0 or 1.

    • person_image string
    • last_updated_datetime_utc string

      The date/time in UTC of the last updated date/time of the contact

    • lastUpdatedDatetimeUtcShowLocal string

      The local datetime (as per the administration-system-date settings), shown in the local format
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"
}