List Memberships

GET /v2/b2b/memberships

inputs:

  • updatedStartTime: (optional) only return memberships updated after this start time.
  • updatedEndTime: (optional) only return memberships updated after this time.
  • program: (optional) only return memberships of this program type.
  • category: (optional) only return memberships of this category.
  • subCategory: (optional) only return memberships of this sub category.

returns:

A list of Membership Objects


Get Membership

GET /v2/b2b/memberships/{id}

returns:

The Membership object with the specified membership id.


Update a Membership

PUT /v1/b2b/memberships

body:

The updated Membership object, must contain the importId of the object being updated. This will update only the cardholder / demographic information. To delete a cardholder, set the cardStatus to "dropped"

returns:

The updated Membership object.


Membership Object

Field
Description
Notes
idA unique ID for this membership.Read Only
program

The program for this membership.


category

Name of the membership type.  Could be Silver, Gold, Platinum, Campaign VIP, Premium, Friend/Dual, Standard Dual/Family, Standard - Individual, Standard - Teacher, Standard - Student/Artist/Senior, Pass, Lifetime Artist, Art Quest, Advocate, Corporate Supporter, Associate, New Group Dual/Institutional, Producers Council, Founders Club.


subcategoryA sub category for this membership.
levelA numeric level for this category
importIdA value that does not change.
fund

The specific financial purposes of gifts.

Read Only
campaignThe overall objective to raise money.Read Only
appeal

The solicitations and promotions that bring in gifts.

Read Only
externalMembershipIdThe id of the membership in an external data source.
membershipJoinedDateThe date this visitor first became a member.

membershipStartDate

The date the current membership started.
membershipExpirationDateThe date that the membership will expire.
membershipStandingThe standing of the membership.
membershipCategoryMembership Level Name
categoryIdMembership Level Id
externalIdID from external source like salesforce

membershipTypeIdA linking back to our membership_types table with the type of membership.
cardholdersThe list of card holders for this membership.
cardholders[x].id
Membership Card Holder ID
cardholders[x].visitorId
ID of the Visitor

cardholders[x].membershipId
Maps to id from the membership table.

cardholders[x].externalCustomerId
Customer ID from external source like salesforce
cardholders[x].externalContactId
Contact ID from external source like salesforce
cardholders[x].constituentId


cardholders[x].acmeCustomerNumber


cardholders[x].constituentImportIdThe import id for the constituent.
cardholders[x].cardImportIdThe import id for this card.
cardholders[x].cardTypeThe type of card holder, one of (primary or other)
cardholders[x].nameThe name on the card.
cardholders[x].barcodeThe value on the barcode.
cardholders[x].acmeBarcodeACME's barcode for
cardholders[x].emailThe member's email address.
cardholders[x].prefixThe prefix for the name. e.g. Mr. or Mrs.
cardholders[x].suffixThe suffix for the name. e.g. Jr.
cardholders[x].firstNameThe member's first name.
cardholders[x].lastNameThe member's last name.
cardholders[x].orgNamethe name of the organization when this membership is an organization membership.
cardholders[x].phoneNumberThe member's phone number.
cardholders[x].phoneNotes


cardholders[x].streetAddress1The member's street address.
cardholders[x].streetAddress2The member's extended street address.
cardholders[x].cityThe member's city.
cardholders[x].stateThe member's state.
cardholders[x].zipCodeThe member's zipCode.
cardholders[x].countryThe country that the member lives in.
cardholders[x].orgName
Organization Name
cardholders[x].orgId
Organization ID
cardholders[x].addressId


cardholders[x].deceased
Boolean value to denote deceased
cardholders[x].suburb


cardholders[x].primaryCard
Boolean value to denote 
cardholders[x].solicitationCodes
List of Solicitation messages for the members
cardholders[x].details


cardholders[x].details[y].admits


cardholders[x].details[y].filmPlusExpirationDate

cardholders[x].details[y].filmPlusStatus

cardholders[x].details[y].juniorAssociateCategory

cardholders[x].details[y].juniorAssociateExpirationDate

cardholders[x].details[y].juniorAssociateStatus

cardholders[x].details[y].ps1PlusStatus


cardholders[x].details[y].ps1ExpirationDate


cardholders[x].cardHolderAttributes


cardholders[x].cardHolderAttributes[y].membershipId
Membership ID
cardholders[x].cardHolderAttributes[y].cardHolderId
Membership Card Holder ID
cardholders[x].cardHolderAttributes[y].categoryMembership Category
cardholders[x].cardHolderAttributes[y].description

cardholders[x].cardHolderAttributes[y].notes

cardholders[x].cardHolderAttributes[y].date
Membership Joined Date
cardholders[x].startDate
Membership start date
cardholders[x].expirationDate
Membership expiration date
cardholders[x].cardStatus
Limit events to those that support the specified card status. Valid card status are:
  • new
  • active
  • dropped 
  • lapsed
  • noMembership
  • replaced

cardholders[x].printCount
Total Membership card printed
cardholders[x].printStatus
Limit events to those that support the specified print status. Valid print status are:
  • printed
  • notPrinted
  • doNotPrint
  • lost


cardholders[x].orgImportId
organization ID from import

cardholders[x].middleName


cardholders[x].acmeCustomerNumber
Unique customer number from ACME
cardholders[x].excludeCardOnMemberCreation
boolean value to exclude card while member creation
cardholders[x].customerId


entitlementsList of entitlements. Fields is only populated if entitlements were imported with the membership
entitlements[x].idUnique ID for this entitlement.READ ONLY
entitlements[x].benefitThe name of the benefit.
entitlements[x].memberId
Membership ID
entitlements[x].visitorId


entitlements[x].countThe number of these benefits the member has.
entitlements[x].importIdThe import id for this entitlement.
entitlements[x].commentA comment about the benefit.
offeringId
Membership Offering ID
pricePointId
Price Point ID for the membership purchase
organizationId
Organization Id
orgImportId


organizationName
Organization Name

isGiftboolean to denote the membership purchase is a gift
auxiliaryMembership
boolean to denote auxiliary membership
membershipLevelCollectionId
Membership Level Group ID

membershipLevelCollectionName
Membership Level Group Name
offeringName
Membership Offering ID


Sample JSON

Sample JSON
{
  "id": 746356,
  "importId""ACMEACS314670906",
  "program""golden2_program",
  "category""golden2_category",
  "subcategory""golden2_subcategory",
  "membershipTypeId": 616,
  "externalMembershipId""ACS314670906",
  "membershipJoinedDate""2016-12-23T00:00:00-08:00",
  "membershipStartDate""2017-06-23T00:00:00-07:00",
  "membershipExpirationDate""2019-06-22T23:59:59-07:00",
  "membershipStanding""active",
  "cardholders": [
    {
      "id": 1146954,
      "membershipId": 746356,
      "constituentImportId""ACMEACS269150004",
      "constituentId""ACS269150004",
      "cardImportId""ACMEACS369056059",
      "cardType""primary",
      "name""Vanor Zhang",
      "barcode""ACS369056059",
      "acmeBarcode""ACS369056059",
      "firstName""Vanor",
      "lastName""Zhang",
      "prefix""",
      "phoneNumber""",
      "streetAddress1""46380 Sentinel",
      "streetAddress2""",
      "city""Fremont",
      "state""Arizona",
      "zipCode""95678",
      "country""United States",
      "deceased""no",
      "primaryCard""yes",
      "solicitationCodes""",
      "startDate""2017-06-23T00:00:00-07:00",
      "expirationDate""2019-06-22T23:59:59-07:00",
      "cardStatus""active",
      "printCount": 0,
      "printStatus""notPrinted",
      "middleName""",
      "acmeCustomerNumber""ACS269150004"
    },
    {
      "id": 1146955,
      "membershipId": 746356,
      "cardImportId""ACMEACS374959567",
      "cardType""secondary",
      "name""Guest of Vanor Zhang",
      "barcode""ACS374959567",
      "acmeBarcode""ACS374959567",
      "deceased""no",
      "primaryCard""no",
      "solicitationCodes""",
      "startDate""2017-06-23T00:00:00-07:00",
      "expirationDate""2019-06-22T23:59:59-07:00",
      "cardStatus""active",
      "printCount": 0,
      "printStatus""notPrinted"
    }
  ],
  "entitlements": [
     
  ],
  "membershipCategory""Golden Membership Test",
  "categoryId""584f7aa179e71d507664059c",
  "acmeMembershipNumber""ACS314670906",
  "isGift"false,
  "auxiliaryMembership"false,
  "offeringName""Two Year Membership",
  "offeringId""069e1a4051aa45ebb53e3705455cb31b",
  "pricePointId""58123480969c6d59d976b8fa"
}