List Memberships as a summary

GET /v1/b2b/membership/summaries

inputs:

  • updatedStartTime: (optional) only return membership summaries updated after this start time.
  • updatedEndTime: (optional) only return membership summaries updated after this time.
  • program: (optional) only return membership summaries of this program type.
  • category: (optional) only return membership summaries of this category.
  • subCategory: (optional) only return membership summaries of this sub category.
  • barcode: (optional) only return the membership summaries that have barcode or acmeBarcodes that begin with this text.  Useful for auto complete.
  • membershipId: (optional) only return membership summaries that have membership ids that begin with this text.  Useful for auto complete.
  • firstName: (optional) only return membership summaries that have first names that begin with this text.  Useful for auto complete.
  • lastName: (optional) only return membership summaries that have last names that begin with this text.  Useful for auto complete.
  • email (optional) only return membership summaries where the primary cardholder has this email
  • city: (optional) only return membership summaries that have cities that begin with this text.  Useful for auto complete.
  • zip: (optional) only return membership summaries that have zip codes that begin with this text.  Useful for auto complete.
  • expiresAfter(optional) String. ISO8601 format. Returns only the memberships that expire after this date. (in sandbox)
  • expiresBefore(optional) String. ISO8601 format. Returns only the memberships that expired before this date. (in sandbox)

returns:

A list of Membership Summary Objects

Sample filter by expiry date range request:

v2/b2b/membership/summaries?expiresAfter=2016-11-20T07:00:00Z&expiresBefore=2016-12-22T07:00:00Z


Membership Summary Object

Field

Description

Notes

idA unique ID for this membership.Read Only
visitorIdThe Visitor ID for this membership. Maps back to Visitor API.
program

The RE program for this membership.


category

Name of the RE membership category.  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 RE subcategory for this membership.
levelA numeric level for this category
externalMembershipIdThe id of the membership in an external data source. The memebrship number in RE, SF or ther external system.
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.
membershipTypeIdA linking back to our membership_types table with the type of membership. A membership type is a combination of RE program, category, subcategory.
constituentId
The RE constituentId for the constituent.
constituentImportIdThe RE import id for the constituent.
cardTypeThe type of card holder, one of (primary or secondary)
nameThe name on the card.
membershipIdThe membership number. If imported from an external system, it will be same as externalMembershipId during the time of import. Immutable after that.
barcodeThe value on the barcode. Could be external barcode when imported from an external system.
acmeBarcodeACME barcode
emailThe primary cardholder's email address.
prefixThe prefix for the name. Like Reverend, Father or Khaleesi.
suffixThe suffix for the name. Like Ph.D. or Knight's Commander.
firstNameThe member's first name.
lastNameThe member's last name.
middleNameThe member's middle name.
orgNamethe name of the organization when this membership is an organization membership.
orgIdthe organization id
orgCompanyUrlThe company url
orgPhoneNumberThe company phone number
orgStreetAddress1The company street address 1
orgStreetAddress2The company street address 2
orgCityThe company city
orgZipCodeThe company zip code
orgCountryThe company's country
orgStateThe company's state
phoneNumberThe member's phone number.
streetAddress1The member's street address.
streetAddress2The member's extended street address.
cityThe member's city.
stateThe member's state.
zipCodeThe member's zipCode.
countryThe country that the member lives in.
categoryId
The Acme category ID of the membership. Also known as the level ID.
offeringId
The offering ID of the membership
pricePointId
The pricepoint ID of the membership
primaryCard
flag to determine wether the card is primary or not.
orgNumber
The organization number
orgImportId
The importID of the organization
cardStartDate
The start date of the card. Could be different from the membership if the card was added at a later stage.
cardExpirationDate
The expiry date of the card.
cardStanding
The standing of the card.
membershipCategory
The membership level name.
cardholderAttributes
A list of attributes for the cardholder(RE specific). An attribute may contain membershipId, cardholderId, category, description,notes.
acmeMembershipNumber
Acme membership number
acmeCustomerNumber
Acme customer number.


Sample request:

sand1-api.acmeticketing.net//v1/b2b/membership/summaries?expiresAfter=2020-03-31T07:00:00&expiresBefore=2021-01-31T07:00:00


Sample response:


{
"list": [
{
"id": 2682672,
"membershipId": 1596023,
"constituentImportId": "ACME223340256",
"cardType": "primary",
"categoryId": "5e94cea560309f38432fdeae",
"offeringId": "1f614f4cae66409cac07478940d0dd54",
"pricePointId": "5e94c7c460309f38432fde40",
"name": "Larry Williams",
"barcode": "377175062",
"acmeBarcode": "377175062",
"email": "mb+larry@acmeticketing.com",
"firstName": "Larry",
"lastName": "Williams",
"phoneNumber": "4155558765",
"streetAddress1": "415 Middle Point Road",
"city": "San Francisco",
"state": "California",
"zipCode": "94124",
"country": "United States",
"primaryCard": true,
"externalMembershipId": "389638651",
"membershipJoinedDate": "2020-07-16T00:00:00-07:00",
"membershipStartDate": "2020-07-16T00:00:00-07:00",
"membershipExpirationDate": "2020-07-15T23:59:59-07:00",
"membershipStanding": "replaced",
"membershipCategory": "Individual",
"cardholderAttributes": [],
"acmeMembershipNumber": "389638651",
"acmeCustomerNumber": "223340256",
"cardStartDate": "2020-07-16T00:00:00-07:00",
"cardExpirationDate": "2020-07-15T00:00:00-07:00",
"cardStanding": "replaced",
"auxiliary": false,
"customerId": 3026448
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"sortDirection": "asc",
"sortField": "name",
"count": 1
}
}