« Back to Documentation OverviewlistInterestGroupings – v1.3
listInterestGroupings(string apikey, string id)
Get the list of interest groupings for a given list, including the label, form information, and included groups for each
| Parameters | xml-rpc_listInterestGroupings.php| apikey | a valid API Key for your user account. Get by visiting your API dashboard |
| id | the list id to connect to. Get by calling lists() |
| Returns | | struct |
list of interest groups for the list
| int | id | The id for the Grouping
| | string | name | Name for the Interest groups
| | string | form_field | Gives the type of interest group: checkbox,radio,select
| | array | groups | Array of the grouping options including:
| string | bit | the bit value - not really anything to be done with this
| | string | name | the name of the group
| | string | display_order | the display order of the group, if set
| | int | subscribers | total number of subscribers who have this group
| | |