getAllLoyaltyMemberships
Retrieve all loyalty memberships for an enterprise with optional filters such as IDs, activity states, or creation dates. Supports pagination and portfolio access tokens for efficient data management.
Instructions
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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| AccountIds | No | Unique identifiers of accounts (for example Customers or Companies) the membership is associated with. | |
| ActivityStates | No | Whether to return only active, only deleted or both records. | |
| ChainIds | No | Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token. | |
| Codes | No | List of loyalty membership codes, such as identification numbers printed on loyalty cards visible to the customer. | |
| CreatedUtc | No | The time interval during which the membership was created (max length 3 months) | |
| Limitation | Yes | Limitation on the quantity of data returned | |
| LoyaltyMembershipIds | No | Unique identifiers of Loyalty memberships. | |
| LoyaltyProgramIds | No | Unique identifiers of Loyalty programs. | |
| MembershipStates | No | States of the loyalty memberships. | |
| ProviderMembershipIds | No | List of unique loyalty membership identifiers assigned and managed by the external loyalty provider's system. | |
| UpdatedUtc | No | The time interval during which the membership was last updated (max length 3 months) |