---
title: "Get all loyalty memberships"
method: POST
path: "/api/connector/v1/loyaltyMemberships/getAll"
tags: ["Loyalty memberships"]
---

# 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](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).

## Request body

- LoyaltyMembershipFilterParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `ChainIds` string[], nullable — Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
  - `CreatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable
  - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable
  - `LoyaltyMembershipIds` string[], nullable — Unique identifiers of [Loyalty memberships](https://mews-systems.gitbook.io/connector-api/operations/#loyalty-membership).
  - `AccountIds` string[], nullable — Unique identifiers of accounts (for example [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) or [Companies](https://mews-systems.gitbook.io/connector-api/operations/companies/#company)) the membership is associated with.
  - `LoyaltyProgramIds` string[], nullable — Unique identifiers of [Loyalty programs](https://mews-systems.gitbook.io/connector-api/operations/loyaltyprograms/#loyalty-program).
  - `MembershipStates` LoyaltyMembershipStateEnum[], nullable — States of the loyalty memberships.
  - `ActivityStates` ActivityStates[], nullable — Whether to return only active, only deleted or both records.
  - `Codes` string[], nullable — List of loyalty membership codes, such as identification numbers printed on loyalty cards visible to the customer.
  - `MembershipNumbers` string[], nullable — Customer-facing membership numbers, e.g., printed on a loyalty card.
  - `ProviderMembershipIds` string[], nullable — List of unique loyalty membership identifiers assigned and managed by the external loyalty provider's system.
  - `Limitation` Limitation, required — Limitation on the quantity of data returned.
    - `Count` integer, required
    - `Cursor` string, uuid, nullable

## Response `200`

OK

- LoyaltyMembershipResult
  - `LoyaltyMemberships` LoyaltyMembership[], required — The loyalty memberships of the enterprise.
    - `Id` string, uuid, required — Unique identifier of the loyalty membership.
    - `ChainId` string, uuid, required — Unique identifier of the chain.
    - `AccountId` string, uuid, required — Unique identifier of the account.
    - `LoyaltyProgramId` string, uuid, required — Unique identifier of the loyalty program.
    - `State` 'New' | 'Pending' | 'Enrolled' | 'Canceled' | 'Declined', required — State of the loyalty membership. New Pending Enrolled Canceled Declined
    - `IsPrimary` boolean, required — Defines the primary loyalty membership.
    - `ProviderMembershipId` string, nullable — Unique identifier for the loyalty membership in the loyalty provider's system.
    - `Code` string, nullable — Code of the loyalty membership.
    - `MembershipNumber` string, nullable — Customer-facing membership numbers, e.g., printed on a loyalty card.
    - `Points` integer, nullable — The loyalty points for the account in that membership.
    - `ExpirationDate` string, date-time, nullable — Expiration date of the loyalty membership in UTC timezone in ISO 8601 format.
    - `Url` string, nullable — Url of the loyalty membership.
    - `LoyaltyTierId` string, uuid, nullable — Unique identifier of the loyalty tier.
    - `CreatorProfile` ProfileData, required — The profile data of the user who created or last updated the record.
      - `Discriminator` 'Personal' | 'Enterprise' | 'Platform' | 'Static' | 'Integration', required
      - `EnterpriseProfile` EnterpriseProfileData
        - `ProfileId` string, uuid, required — Unique identifier of the profile.
    - `UpdaterProfile` ProfileData, required — The profile data of the user who created or last updated the record.
      - `Discriminator` 'Personal' | 'Enterprise' | 'Platform' | 'Static' | 'Integration', required
      - `EnterpriseProfile` EnterpriseProfileData
        - `ProfileId` string, uuid, required — Unique identifier of the profile.
  - `Cursor` string, 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.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — 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).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — 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.
- `408` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — 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](https://github.com/MewsSystems/gitbook-connector-api).

---

[API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/4bf95cbc375f/schema)