groups/getInfo

Find group based on its ID. The fields listed here will be returned when this method is called.

POST https://api.elvanto.com/v1/groups/getInfo.{json|xml|php}

Parameters

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.
Expected request JSON HTTP POST
{
    "id": "57beccc8-af4a-11e0-9b4e-f27fa4b6a61b",
    "fields": [
        "people"
    ]
}
Expected response JSON XML PHP
{
    "generated_in": "0.021",
    "status": "ok",
    "group": [
        {
            "id": "57beccc8-af4a-11e0-9b4e-f27fa4b6a61b",
            "date_added": "2016-07-16 01:24:25",
            "date_modified": "2016-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": ""
                    }
                ]
            }
        }
    ]
}
Error responses:

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

  • 404: Invalid Group ID The Group ID you provided does not exist.