Home

Download this help site
(PDF 82MB)

Download

MemberGroups 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 MemberGroups API call to retrieve information about member groups. You can retrieve information for all member groups, and just for a specified group.

Retrieving information for all groups

Syntax

Example

Retrieving information for a particular group

Syntax

Example

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.

Parameters

The following parameters are used within the MemberGroups 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.

{groupID}The unique identifier of a member group. Groups IDs are returned by the MemberGroups API call.

Response fields

For each member group, the MemberGroups API call retrieves the following information.

Field

Description

ContactsCountThe number of contacts in the member group.
ContactIDsThe contact IDs of contacts in the member group.
DescriptionThe description entered for the member group.
IDThe unique identifier of the member group.
URLThe address of the API call for this group.
NameThe name assigned to the member group.

Sample JSON response

Sample XML response

 

 

On this page:   

See also:

  • No labels