Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated with API changes from Cindy.





Performs a search for a list of individuals based on First Name, Last Name or Goes By Name.



John Doe&pageIndex=0&pageSize=550


pageIndex and pageSize are not required for the API to work properly. These fields let you limit the number of records returned at one time and when you begin pulling information. If you do not enter this information, the index default is 0 and the size default is 50. 


Within our example, the %20 represents a space. You can include this or simply use a space. In our example, to display the entire URL, the optional pageIndex and pageSize display on the next line. In actual usage, these two lines would be one.

Required Permissions

User with security rights to lookup individual information.

The user must fall into one of the categories below:

  • System Administration

  • A user with the following rights:

    • Rights to Locate Person

    • Rights to Member Search

Request Header

Basic Authorization is used to determine security rights for the user credentials supplied using the following parameters.

username: "jadams"

password: "password231"


URL Parameters

sitenumber – The site number to gather data for.



                John Doe

q=letter – [All individuals with last names, first names, and goes by names beginning with that letter]

Example: [a]

Aaron, James

Banning, Ann

Thorpe, Grace Ann (Ann)


When searching by letter, results display in alphabetical order by last name.

Return Data

Code Block
  "Page": [
      "IndvId": 12,
      "FamId": 1234,
      "FamilyPosition": "Head",
      "Title": "Mr.",
      "FirstName": "Johnathon",
      "LastName": "Doe",
      "MiddleName": null,
      "GoesByName": "John",
      "Suffix": null"
  "PageCount": 1,
  "PageIndex": 0,
  "PageSize": 550