people/search

Find one or more people that match a specific search query. The fields listed here will be returned when this method is called.

POST https://api.elvanto.com/v1/people/search.{json|xml|php}

Notes

  • date_entered, date_modified and last_login parameters need to be searched in UTC time.
  • date_entered, date_modified and last_login parameters need to be searched as yyyy-mm-dd hh:mm:ss (e.g: 2013-07-15 15:37:03) or yyyy-mm-dd (e.g: 2013-07-15).
  • date_entered, date_modified and last_login parameters will be searched as: parameter.date_modified >= person.date_modified (greater than or equal to).

Parameters

Name Type Description
page integer The results page to retrieve. Default: 1
page_size integer The number of records to retrieve per results page. Default: 1000
search Required array An array of fields you are searching. Each key represents a field. Each value represents your keywords. Fields (keys) currently searchable are listed below.
fields array Optional fields you would like to retrieve for each person. More information on people fields.

The following fields (keys) can be used in the "search" parameter

Name Type Description Accepted Values
date_added datetime The date the person was added. Date in UTC time.
date_modified datetime The date the person was last modified. Date in UTC time.
category_id string The ID of the category this person is in.
firstname string The first name of the person.
preferred_name string The preferred name for the person (their nick name for example).
lastname string The last name of the person.
email string The email address of the person.
phone string The phone number for the person.
mobile string The mobile number for the person.
archived integer Whether this person is archived. Yes or No
contact integer Whether this person is a contact. Yes or No
deceased integer Whether this person is deceased. Yes or No
volunteer integer Whether this person is a volunteer. Yes or No
last_login datetime The date the person last logged into their account. Date in UTC time.
gender string The gender of the person. Male or Female
birthday date The date the person was born. 2016-12-03 (yyyy-mm-dd)
anniversary date The person's anniversary date. 2016-12-03 (yyyy-mm-dd)
school_grade string The name of the school grade.
marital_status string The person's marital status. Single, Engaged, Married, Widowed, Divorced, Separated or Defacto
development_child string Is this a development child? Yes or No
special_needs_child string Is this a special needs child? Yes or No
security_code string Security code for check-in.
receipt_name string The receipt name used for financial records.
giving_number string The giving number used for financial records.
groups string|array The groups this person is assigned to. The name or ID of a group. For multiple groups, put into an array.
Expected request JSON HTTP POST
{
    "page": 1,
    "page_size": 100,
    "search": {
        "date_entered": "2016-01-01",
        "volunteer": "yes",
        "custom_77493627-aaba-426e-48dc-b0b0d8d24c99": "Plumber"
    },
    "fields": [
        "gender",
        "birthday",
        "locations",
        "custom_77493627-aaba-426e-48dc-b0b0d8d24c99"
    ]
}
Expected response JSON XML PHP
{
    "generated_in": "0.018",
    "status": "ok",
    "people": {
        "on_this_page": 100,
        "page": 1,
        "per_page": 100,
        "total": 154,
        "person": [
            {
                "id": "b0b0d8d2-48dc-426e-aaba-774936274c99",
                "date_added": "2016-02-24 11:56:22",
                "date_modified": "2016-08-27 16:17:57",
                "category_id": "8a631195-8914-4136-858c-f160885ab60d",
                "firstname": "John",
                "preferred_name": "Jonny",
                "lastname": "Smith",
                "email": "john@johnsmith.com",
                "phone": "999-999-999",
                "mobile": "888-888-888",
                "admin": 0,
                "archived": 0,
                "contact": 0,
                "volunteer": 1,
                "status": "Active",
                "username": "john.smith",
                "last_login": "2016-08-28 12:32:22",
                "country": "United Kingdom",
                "timezone": "Europe/London",
                "picture": "http://url.to/picture.jpg",
                "family_id": 10,
                "family_relationship": "Primary Contact",
                "birthday": "1989-04-23",
                "gender": "Male",
                "locations": {
                    "location": [
                        {
                            "id": "8a631195-8914-4136-858c-f160885ab60d",
                            "name": "Central Campus"
                        },
                        {
                            "id": "9f3aec97-3d61-471d-ab50-5f28070d970d",
                            "name": "North Campus"
                        }
                    ]
                },
                "custom_77493627-aaba-426e-48dc-b0b0d8d24c99": "Plumber"
            },
            {
                "id": "8ff1098d-5f38-41fd-a594-d116f3d1650b",
                "date_added": "2016-01-15 14:21:13",
                "date_modified": "2016-07-30 09:23:01",
                "category_id": "8a631195-8914-4136-858c-f160885ab60d",
                "firstname": "Sandra",
                "preferred_name": "",
                "lastname": "Johnson",
                "email": "sandra@johnson.com",
                "phone": "999-999-999",
                "mobile": "888-888-888",
                "admin": 0,
                "archived": 0,
                "contact": 0,
                "volunteer": 1,
                "status": "Active",
                "username": "",
                "last_login": "",
                "country": "United Kingdom",
                "timezone": "Europe/London",
                "picture": "http://url.to/picture.jpg",
                "family_id": 10,
                "family_relationship": "Spouse",
                "birthday": "1974-10-21",
                "gender": "Female",
                "locations": {
                    "location": [
                        {
                            "id": "8a631195-8914-4136-858c-f160885ab60d",
                            "name": "Central Campus"
                        }
                    ]
                },
                "custom_77493627-aaba-426e-48dc-b0b0d8d24c99": "Plumber"
            }
        ]
    }
}
Error responses:

Please see our response status codes documentation for details of potential error responses for any API request.

  • 250: Invalid page number The page number you have provided is invalid.
  • 250: Invalid page size The page size must be between 10 and 1000.
  • 250: No search parameters provided You need to provide something for the API to search for.
  • 250: Invalid search parameter One of the search parameters you used are not searchable.
  • 404: No people match your criteria The system could not find any people based on your criteria.