Find group based on its ID. The fields listed here will be returned when this method is called.
POSThttps://api.elvanto.com/v1/groups/getInfo.{json|xml|php}
Name | Type | Description |
---|---|---|
id Required | string | The ID of the group. |
fields | array | Optional fields you would like to retrieve for the group. More information on group fields. |
{
"id": "57beccc8-af4a-11e0-9b4e-f27fa4b6a61b",
"fields": [
"people"
]
}
id=57beccc8-af4a-11e0-9b4e-f27fa4b6a61b&fields[0]=people
{
"generated_in": "0.021",
"status": "ok",
"group": [
{
"id": "57beccc8-af4a-11e0-9b4e-f27fa4b6a61b",
"date_added": "2024-07-16 01:24:25",
"date_modified": "2024-08-08 16:27:25",
"name": "Family Connect",
"status": "Active",
"description": "<p>A group to connect families together</p>",
"picture": "http://url.to/picture.jpg",
"meeting_address": "13 Westburn Ave",
"meeting_city": "Westburn",
"meeting_postcode": "4321",
"meeting_country": "Australia",
"meeting_day": "Monday",
"meeting_time": "6:30 PM",
"meeting_frequency": "Every 2 Weeks",
"people": {
"person": [
{
"id": "ed9f8e3e-a3b5-11e1-bb45-541f9db7bc89",
"firstname": "Sandy",
"preferred_name": "",
"lastname": "Johnson",
"email": "sandy@johnson.com",
"mobile": "999-999-999",
"phone": "888-888-888",
"picture": "http://url.to/picture.jpg",
"position": "Leader"
},
{
"id": "7675eed8-e90d-11e0-a4e0-1dee54d73a9e",
"firstname": "Robert",
"preferred_name": "Bob",
"lastname": "O'Donnell",
"email": "robert@odonnell.com",
"mobile": "999-999-999",
"phone": "888-888-888",
"picture": "http://url.to/picture.jpg",
"position": ""
}
]
}
}
]
}
<?xml version="1.0" encoding="UTF-8"?> <rsp generated_in="0.021" status="ok"> <group id="57beccc8-af4a-11e0-9b4e-f27fa4b6a61b"> <date_added>2024-07-16 01:24:25</date_added> <date_modified>2024-08-08 16:27:25</date_modified> <name>Family Connect</name> <status>Active</status> <description><![CDATA[<p>A group to connect families together</p>]]></description> <picture>http://url.to/picture.jpg</picture> <meeting_address>13 Westburn Ave</meeting_address> <meeting_city>Westburn</meeting_city> <meeting_postcode>4321</meeting_postcode> <meeting_country>Australia</meeting_country> <meeting_day>Monday</meeting_day> <meeting_time>6:30 PM</meeting_time> <meeting_frequency>Every 2 Weeks</meeting_frequency> <people> <person id="ed9f8e3e-a3b5-11e1-bb45-541f9db7bc89"> <firstname>Sandy</firstname> <preferred_name></preferred_name> <lastname>Johnson</lastname> <email>sandy@johnson.com</email> <mobile>999-999-999</mobile> <phone>888-888-888</phone> <picture>http://url.to/picture.jpg</picture> </person> <person id="7675eed8-e90d-11e0-a4e0-1dee54d73a9e"> <firstname>Robert</firstname> <preferred_name>Bob</preferred_name> <lastname>O'Donnell</lastname> <email>robert@odonnell.com</email> <mobile>999-999-999</mobile> <phone>888-888-888</phone> <picture>http://url.to/picture.jpg</picture> </person> </people> </group> </rsp>
stdClass Object
(
[generated_in] => 0.021
[status] => ok
[group] => stdClass Object
(
[0] => stdClass Object
(
[id] => 57beccc8-af4a-11e0-9b4e-f27fa4b6a61b
[date_added] => 2024-07-16 01:24:25
[date_modified] => 2024-08-08 16:27:25
[name] => Family Connect
[status] => Active
[description] => <p>A group to connect families together</p>
[picture] => http://url.to/picture.jpg
[meeting_address] => 13 Westburn Ave
[meeting_city] => Westburn
[meeting_postcode] => 4321
[meeting_country] => Australia
[meeting_day] => Monday
[meeting_time] => 6:30 PM
[meeting_frequency] => Every 2 Weeks
[people] => stdClass Object
(
[person] => stdClass Object
(
[0] => stdClass Object
(
[id] => ed9f8e3e-a3b5-11e1-bb45-541f9db7bc89
[firstname] => Sandy
[preferred_name] =>
[lastname] => Johnson
[email] => sandy@johnson.com
[mobile] => 999-999-999
[phone] => 888-888-888
[picture] => http://url.to/picture.jpg
[position] => Leader
)
[1] => stdClass Object
(
[id] => 7675eed8-e90d-11e0-a4e0-1dee54d73a9e
[firstname] => Robert
[preferred_name] => Bob
[lastname] => O'Donnell
[email] => robert@odonnell.com
[mobile] => 999-999-999
[phone] => 888-888-888
[picture] => http://url.to/picture.jpg
[position] =>
)
)
)
)
)
)
Please see our response status codes documentation for details of potential error responses for any API request.