Bundles API V2 call
You can use the Bundles API call to retrieve information about a particular membership bundle. You can retrieve information for a specific bundle, or retrieve information for all bundles created using a particular membership level.
Retrieving information about a particular bundle
You can retrieve bundle information about a specific bundle by specifying the bundle ID. The bundle ID is returned by the Contacts API call, and by the Bundles API call when using it to retrieve bundle information for a particular membership level (see below).
Retrieving bundle information for a membership level
You can retrieve bundle information for all bundles created using a particular membership level by specifying the membership level ID.
The following parameters are used within the Bundles API call:
The base address of the API. For more information, see API access options.
The unique identifier for a membership bundle. The bundle ID is returned by the Contacts API call, and by the Bundles API call when using it to retrieve bundle information for a particular membership level.
The unique identifier for a membership level. The membership level ID is returned by the MembershipLevels API call.
For each bundle, the Bundles API call retrieves the following information.
|The email address of the bundle administrator.|
|ParticipantsCount||The number of members in the bundle.|
|Administrator||The contact ID and contact URL of the bundle administrator.|
|MembershipLevel||The ID and URL of the membership level used to create the bundle.|
|SpaceLeft||The number of spaces left in the bundle.|
|Members||The contact ID and contact URL of each member in the bundle. This field is only returned when the request is sent using a bundle ID.|
|ID||The bundle ID.|
|URL||The address of the API request for the bundle.|