Get all loyalty memberships
POST /api/connector/v1/loyaltyMemberships/getAll
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.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
The time interval during which the membership was created.
object
The time interval during which the membership was last updated.
object
Unique identifiers of Loyalty memberships.
Unique identifiers of Loyalty programs.
States of the loyalty memberships.
Whether to return only active, only deleted or both records.
List of loyalty membership codes, such as identification numbers printed on loyalty cards visible to the customer.
List of unique loyalty membership identifiers assigned and managed by the external loyalty provider’s system.
Limitation on the quantity of data returned.
object
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ChainIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "5fcd1933-22f2-40b9-84da-7db04cbecec2" ], "CreatedUtc": { "StartUtc": "2022-10-15T00:00:00Z", "EndUtc": "2022-10-20T00:00:00Z" }, "UpdatedUtc": { "StartUtc": "2022-10-15T00:00:00Z", "EndUtc": "2022-10-20T00:00:00Z" }, "LoyaltyMembershipIds": [ "905a4489-0960-4ac9-96ec-793f47365c92", "ac48674e-58a2-43d6-a02b-9ead0b213b17" ], "AccountIds": [ "fadd5bb6-b428-45d5-94f8-fd0d89fece6d", "bccdafd1-3e44-439d-861f-341526b597a9" ], "LoyaltyProgramIds": [ "f701dafb-5765-4cf4-b1dd-1f602a740ae5" ], "MembershipStates": [ "Pending", "Enrolled" ], "ActivityStates": [ "Active" ], "Codes": [ "MBR-2025-AX49ZT73" ], "ProviderMembershipIds": [ "PRV-MBR-9842XKLT" ], "Limitation": { "Count": 100 }}Responses
Section titled “ Responses ”OK
object
The loyalty memberships of the enterprise.
object
Unique identifier of the loyalty membership.
Unique identifier of the chain.
Unique identifier of the account.
Unique identifier of the loyalty program.
State of the loyalty membership.
New
Pending
Enrolled
Canceled
Declined
Defines the primary loyalty membership.
Unique identifier for the loyalty membership in the loyalty provider’s system.
Code of the loyalty membership.
The loyalty points for the account in that membership.
Expiration date of the loyalty membership in UTC timezone in ISO 8601 format.
Url of the loyalty membership.
Unique identifier of the loyalty tier.
The profile data of the user who created or last updated the record.
object
Enterprise profile data.
object
Unique identifier of the profile.
The profile data of the user who created or last updated the record.
object
Enterprise profile data.
object
Unique identifier of the profile.
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.
Example
{ "LoyaltyMemberships": [ { "Id": "905a4489-0960-4ac9-96ec-793f47365c92", "ChainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "AccountId": "fadd5bb6-b428-45d5-94f8-fd0d89fece6d", "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5", "State": "New", "IsPrimary": true, "ProviderMembershipId": "PRV-MBR-9842XKLT", "Code": "MBR-2025-AX49ZT73", "Points": 22, "ExpirationDate": "2029-11-04T13:00:00Z", "Url": "https://rewards.example.com/member/PRV-MBR-9842XKLT", "LoyaltyTierId": "69eedfd2-6f25-42fc-b3c8-39df70f85e37", "CreatorProfile": null, "UpdaterProfile": null } ], "Cursor": "905a4489-0960-4ac9-96ec-793f47365c92"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.