Home

Download this help site
(PDF 82MB)

Download

Bundles API V2 call

Icon

Wild Apricot's API is intended for use by developers with technical expertise. If you need assistance, we provide support via email or through our Developers forum.

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).

Syntax

Example

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.

Syntax

Example

Parameters

The following parameters are used within the Bundles API call:

Variable

Description

{baseAPIaddress}

The base address of the API. For more information, see API access options.

{accountID}

The account identifier that appears on the Account and billing screen and is returned by the Accounts API call.

{bundleID}

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.

{levelID}

The unique identifier for a membership level. The membership level ID is returned by the MembershipLevels API call.

Icon

Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see Authenticating API access from a 3rd-party server or application or Authenticating API access from a Wild Apricot site page.

Response fields

For each bundle, the Bundles API call retrieves the following information.

Field

Description

EmailThe email address of the bundle administrator.
ParticipantsCountThe number of members in the bundle.
AdministratorThe contact ID and contact URL of the bundle administrator.
MembershipLevelThe ID and URL of the membership level used to create the bundle.
SpaceLeftThe number of spaces left in the bundle.
MembersThe 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.
IDThe bundle ID.
URLThe address of the API request for the bundle.

Sample JSON response

Sample XML response

On this page:   

See also:

  • No labels