Get a list of all people. The fields listed here will be returned when this method is called.
POSThttps://api.elvanto.com/v1/people/getAll.{json|xml|php}
| 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 |
| category_id | string|array | The ID of the category you'd like to include people from. Can be a string or array of ID's. |
| suspended | string | Would you like to only retrieve suspended people (yes) or not include them (no)? Defaults to all. |
| contact | string | Would you like to only retrieve contacts (yes) or not include them (no)? Defaults to all. |
| archived | string | Would you like to only retrieve archived people (yes) or not include them (no)? Defaults to all. |
| fields | array | Optional fields you would like to retrieve for each person. More information on people fields. |
{
"page": 1,
"page_size": 100,
"category_id": "8a631195-8914-4136-858c-f160885ab60d",
"fields": [
"gender",
"birthday",
"locations",
"custom_77493627-aaba-426e-48dc-b0b0d8d24c99"
]
}page=1&page_size=100&category_id=8a631195-8914-4136-858c-f160885ab60d&fields[0]=gender&fields[1]=birthday&fields[2]=locations&fields[3]=custom_77493627-aaba-426e-48dc-b0b0d8d24c99{
"generated_in": "0.021",
"status": "ok",
"people": {
"on_this_page": 100,
"page": 1,
"per_page": 100,
"total": 668,
"person": [
{
"id": "b0b0d8d2-48dc-426e-aaba-774936274c99",
"date_added": "2024-02-24 11:56:22",
"date_modified": "2024-08-27 16:17:57",
"category_id": "8a631195-8914-4136-858c-f160885ab60d",
"firstname": "John",
"preferred_name": "Jonny",
"middle_name": "Abraham",
"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": "2024-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": "Gardner"
},
{
"id": "8ff1098d-5f38-41fd-a594-d116f3d1650b",
"date_added": "2024-01-15 14:21:13",
"date_modified": "2024-07-30 09:23:01",
"category_id": "8a631195-8914-4136-858c-f160885ab60d",
"firstname": "Sandra",
"preferred_name": "",
"middle_name": "Kay",
"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": "IT Support"
}
]
}
}<?xml version="1.0" encoding="UTF-8"?>
<rsp generated_in="0.021" status="ok">
<people on_this_page="100" page="1" per_page="100" total="668">
<person id="b0b0d8d2-48dc-426e-aaba-774936274c99" category_id="8a631195-8914-4136-858c-f160885ab60d" admin="0" archived="0" contact="0" volunteer="1" family_id="10">
<date_added>2024-02-24 11:56:22</date_added>
<date_modified>2024-08-27 16:17:57</date_modified>
<firstname>John</firstname>
<preferred_name>Jonny</preferred_name>
<middle_name>Abraham</middle_name>
<lastname>Smith</lastname>
<email>john@johnsmith.com</email>
<phone>999-999-999</phone>
<mobile>888-888-888</mobile>
<status>Active</status>
<username>john.smith</username>
<last_login>2024-08-28 12:32:22</last_login>
<country>United Kingdom</country>
<timezone>Europe/London</timezone>
<picture>http://url.to/picture.jpg</picture>
<family_relationship>Primary Contact</family_relationship>
<birthday>1989-04-23</birthday>
<gender>Male</gender>
<locations>
<location id="8a631195-8914-4136-858c-f160885ab60d">
<name>Central Campus</name>
</location>
<location id="9f3aec97-3d61-471d-ab50-5f28070d970d">
<name>North Campus</name>
</location>
</locations>
<custom_77493627-aaba-426e-48dc-b0b0d8d24c99>Gardner</custom_77493627-aaba-426e-48dc-b0b0d8d24c99>
</person>
<person id="8ff1098d-5f38-41fd-a594-d116f3d1650b" category_id="8a631195-8914-4136-858c-f160885ab60d" admin="0" archived="0" contact="0" volunteer="1" family_id="10">
<date_added>2024-01-15 14:21:13</date_added>
<date_modified>2024-07-30 09:23:01</date_modified>
<firstname>Sandra</firstname>
<preferred_name></preferred_name>
<middle_name>Kay</middle_name>
<lastname>Johnson</lastname>
<email>sandra@johnson.com</email>
<phone>999-999-999</phone>
<mobile>888-888-888</mobile>
<status>Active</status>
<username></username>
<last_login></last_login>
<country>United Kingdom</country>
<timezone>Europe/London</timezone>
<picture>http://url.to/picture.jpg</picture>
<family_relationship>Spouse</family_relationship>
<birthday>1974-10-21</birthday>
<gender>Female</gender>
<locations>
<location id="8a631195-8914-4136-858c-f160885ab60d">
<name>Central Campus</name>
</location>
</locations>
<custom_77493627-aaba-426e-48dc-b0b0d8d24c99>IT Support</custom_77493627-aaba-426e-48dc-b0b0d8d24c99>
</person>
</people>
</rsp>
stdClass Object
(
[generated_in] => 0.021
[status] => ok
[people] => stdClass Object
(
[on_this_page] => 100
[page] => 1
[per_page] => 100
[total] => 668
[person] => stdClass Object
(
[0] => stdClass Object
(
[id] => b0b0d8d2-48dc-426e-aaba-774936274c99
[date_added] => 2024-02-24 11:56:22
[date_modified] => 2024-08-27 16:17:57
[category_id] => 8a631195-8914-4136-858c-f160885ab60d
[firstname] => John
[preferred_name] => Jonny
[middle_name] => Abraham
[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] => 2024-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] => stdClass Object
(
[location] => stdClass Object
(
[0] => stdClass Object
(
[id] => 8a631195-8914-4136-858c-f160885ab60d
[name] => Central Campus
)
[1] => stdClass Object
(
[id] => 9f3aec97-3d61-471d-ab50-5f28070d970d
[name] => North Campus
)
)
)
[custom_77493627-aaba-426e-48dc-b0b0d8d24c99] => Gardner
)
[1] => stdClass Object
(
[id] => 8ff1098d-5f38-41fd-a594-d116f3d1650b
[date_added] => 2024-01-15 14:21:13
[date_modified] => 2024-07-30 09:23:01
[category_id] => 8a631195-8914-4136-858c-f160885ab60d
[firstname] => Sandra
[preferred_name] =>
[middle_name] => Kay
[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] => stdClass Object
(
[location] => stdClass Object
(
[0] => stdClass Object
(
[id] => 8a631195-8914-4136-858c-f160885ab60d
[name] => Central Campus
)
)
)
[custom_77493627-aaba-426e-48dc-b0b0d8d24c99] => IT Support
)
)
)
)
Please see our response status codes documentation for details of potential error responses for any API request.