List Memberships as a summary
GET /v2/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 |
|---|---|
| id | A unique ID for this membership. (Read Only) |
| visitorId | n/a. ACME internal only field - do not use |
| program | The program for this membership. |
| category | Name of the membership category |
| subcategory | A subcategory for this membership. |
| level | A numeric level for this category |
| externalMembershipId | The id of the membership in an external data source (typically the CRM system) |
| membershipJoinedDate | The date this customer first became a member. |
membershipStartDate | The date the current membership term began. |
| membershipExpirationDate | The date that the current membership term will expire. |
| membershipStanding | The standing of the membership (active, lapsed) |
| membershipTypeId | A linking back to our membership_types table with the type of membership. A membership type is a combination of program, category, subcategory. |
| constituentId | The constituentId for the constituent. |
| constituentImportId | The import id for the constituent. |
| cardType | The type of card holder (primary, secondary) |
| name | The cardholder's name as printed on the card. |
| membershipId | The membership number. If imported from an external system, it will be same as externalMembershipId during the time of import. Immutable after that. |
| barcode | The value on the barcode. Could be external barcode when imported from an external system. |
| acmeBarcode | ACME barcode |
| The primary cardholder's email address. | |
| prefix | The prefix for the name. (Mr., Ms., Mrs., Dr.) |
| suffix | The suffix for the name. |
| firstName | The member's first name. |
| lastName | The member's last name. |
| middleName | The member's middle name. |
| orgName | the name of the organization when this membership is an organization membership. |
| orgId | the organization id |
| orgCompanyUrl | The organization url |
| orgPhoneNumber | The organization phone number |
| orgStreetAddress1 | The organization's street address 1 |
| orgStreetAddress2 | The organization's street address line 2 |
| orgCity | The organization's city |
| orgZipCode | The organization's zip/postal code |
| orgCountry | The organization's country |
| orgState | The organization's state/province |
| phoneNumber | The member's phone number. |
| streetAddress1 | The member's street address. |
| streetAddress2 | The member's street address line 2 |
| city | The member's city. |
| state | The member's state/province |
| zipCode | The member's zip/postal Code. |
| country | The member's country |
| 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 whether 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 (active, lapsed) |
| membershipCategory | The membership level name. |
| cardholderAttributes | A list of attributes for the cardholder (no longer in use) |
| acmeMembershipNumber | Acme membership number |
| acmeCustomerNumber | Acme customer number. |
Sample request:
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
}
}