Follow

MemberGroups API call

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.

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.

Retrieving information for all groups

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/MemberGroups
Example
GET https://api.wildapricot.org/v2/Accounts/58293/MemberGroups

Retrieving information for a particular group

Syntax
GET [baseAPIaddress]/v2/Accounts/[accountID]/MemberGroups/[groupID]
Example
GET https://api.wildapricot.org/v2/Accounts/58293/MemberGroups/507
Each API call must include an authentication information that verifies your account and prevents others from accessing your data. For more information, see API access options.

Parameters

The following parameters are used within the MemberGroups API call:

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

accountID
The account identifier that 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.

ContactIDs
The contact IDs of contacts in the member group.

ContactsCount
The number of contacts in the member group.

Description
The description entered for the member group.

ID
The unique identifier of the member group.

Name
The name assigned to the member group.

URL
The address of the API call for this group.

Sample JSON response

[
{
"ContactsCount": 5,
"Description": "Members of the advisory board",
"Id": 505,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MemberGroups/505",
"Name": "Board members"
},
{
"ContactsCount": 18,
"Description": "Master mailing list",
"Id": 507,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MemberGroups/507",
"Name": "Mailing list"
},
{
"ContactsCount": 3,
"Description": "Members of the volunteer committee",
"Id": 506,
"Url": "http://api.wildapricot.org/v2/accounts/42353/MemberGroups/506",
"Name": "Volunteer committee"
}
]

Sample XML response

<ArrayOfMembershipGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bonasource.MembershipFS.PublicAPI.Model.V2.Contacts">
<MembershipGroup>
<Id xmlns="http://api.wildapricot.org">505</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/MemberGroups/505</Url>
<Name xmlns="http://api.wildapricot.org">Board members</Name>
<ContactIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<ContactsCount>5</ContactsCount>
<Description>Members of the advisory board</Description>
</MembershipGroup>
<MembershipGroup>
<Id xmlns="http://api.wildapricot.org">507</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/MemberGroups/507</Url>
<Name xmlns="http://api.wildapricot.org">Mailing list</Name>
<ContactIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<ContactsCount>18</ContactsCount>
<Description>Master mailing list</Description>
</MembershipGroup>
<MembershipGroup>
<Id xmlns="http://api.wildapricot.org">506</Id>
<Url xmlns="http://api.wildapricot.org">http://api.wildapricot.org/v2/accounts/42353/MemberGroups/506</Url>
<Name xmlns="http://api.wildapricot.org">Volunteer committee</Name>
<ContactIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<ContactsCount>3</ContactsCount>
<Description>Members of the volunteer committee</Description>
</MembershipGroup>
</ArrayOfMembershipGroup>

0 Comments

Please sign in to leave a comment.

Search: WildApricot.com 

About results ( seconds) Sort by: 
Sorry, an error occured when performing search.