getAddressBookGroups

Provides a list of Address Book group names and group IDs for the logged in user.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRAddressBookAPI	None.	GET, POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRAddressBookAPI?method=getAddressBookGroups &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] [ &count_contacts=value ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters: See topic Common Parameters.
count_contacts: Optional. Whether or not to include a count of contacts belonging to a group.
Type xsd:boolean.
auth: Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Luminate Online web page.
sso_auth_token: Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getAddressBookGroupsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <group>
    <id>1000</id>
    <name>Sample Group 1</name>
    <contactsCount>3</contactsCount>
  </group>
  <group>
    <id>1001</id>
    <name>Sample Group 2</name>
    <contactsCount>4</contactsCount>
  </group>
  <group>
    <id>1002</id>
    <name>Sample Group 3</name>
    <contactsCount>5</contactsCount>
  </group>
</getAddressBookGroupsResponse>

JSON response

JSON

{
    "getAddressBookGroupsResponse": {
        "group": [
            {
                "name": "Sample Group 1",
                "contactsCount": "3",
                "id": "1000"
            },
            {
                "name": "Sample Group 2",
                "contactsCount": "4",
                "id": "1001"
            },
            {
                "name": "Sample Group 3",
                "contactsCount": "5",
                "id": "1002"
            }
        ]
    }
}