Sign in
Loyalty memberships

Get all loyalty memberships

Returns all loyalty memberships of the enterprise, optionally filtered by specific loyalty membership identifiers, activity states, or other filter parameters. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/loyaltyMemberships/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

ChainIdsstring[] nullable

Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.

LoyaltyMembershipIdsstring[] nullable

Unique identifiers of Loyalty memberships.

AccountIdsstring[] nullable

Unique identifiers of accounts (for example Customers or Companies) the membership is associated with.

LoyaltyProgramIdsstring[] nullable

Unique identifiers of Loyalty programs.

MembershipStatesLoyaltyMembershipStateEnum[] nullable

States of the loyalty memberships.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted or both records.

Codesstring[] nullable

List of loyalty membership codes, such as identification numbers printed on loyalty cards visible to the customer.

MembershipNumbersstring[] nullable

Customer-facing membership numbers, e.g., printed on a loyalty card.

ProviderMembershipIdsstring[] nullable

List of unique loyalty membership identifiers assigned and managed by the external loyalty provider's system.

Response

OK

Cursorstring uuid nullable

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Changes

Changed in 1 of the 10 revisions of this API.2

  • 1c5f2fda42e22See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added