GET

List Accounts

Deprecated

This method has been replaced with Query Loyalty Accounts, and will be removed on June 1, 2025.

Deprecation Notice

This method has been replaced with Query Loyalty Accounts and will be removed on June 30, 2025. If your app uses this method, we recommend updating your code as soon as possible.

Retrieves a list of accounts, given the provided filters.

You can retrieve selected loyalty accounts with an array of contactIds or retrieve a list of all of a site's loyalty accounts with an empty request parameter. Use the cursorPaging parameters to limit how many items load at a time.

Deprecated endpoint, please use QueryLoyaltyAccounts or SearchAccounts instead.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions

Learn more about app permissions.

Endpoint

GET

https://www.wixapis.com/loyalty-accounts/v1/accounts

Query Params

contactIdsArray <string>

List of contact IDs. See the Contacts API to learn more.

cursorPaging.limitintegerminimum 0maximum 100format int32

Maximum number of items to return in the results.

cursorPaging.cursorstringmaxLength 16000

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.

Response Object

accountsArray <LoyaltyAccount>

Loyalty accounts.

pagingMetadataPagingMetadata

Details on the paged set of results returned.

Example shown:Get a list of accounts, filtered by contact ids

Request

cURL


curl -X GET \
  'https://www.wixapis.com/loyalty-accounts/v1/accounts?contactIds[]=88615e02-3e8a-4297-8939-5d0a432b322a&contactIds[]=fb8f125e-bfc3-4d9a-80c2-215494f24731' \
  -H 'Authorization: <AUTH>'

Response

JSON


{
  "accounts": [
    {
      "id": "e6f39a5b-a6d0-4556-b889-0cf09d8a84f7",
      "contactId": "88615e02-3e8a-4297-8939-5d0a432b322a",
      "memberId": "a517751b-a1ca-4423-8d91-aaf8f5b34215",
      "points": {
        "balance": 15,
        "earned": 10,
        "redeemed": 0,
        "adjusted": 5
      },
      "rewardAvailable": true,
      "createdDate": "2021-12-06T14:33:19.114Z",
      "updatedDate": "2021-12-07T07:30:23.749Z",
      "revision": "4",
      "tier": {
        "id": "1415f107-640c-4e04-870f-149cdd562093",
        "updatedDate": "2021-12-07T07:30:23.749Z",
        "recalculationDate": null,
        "points": 15
      },
      "lastActivityDate": "2021-12-07T07:30:23.749Z",
      "contact": {
        "id": "7728152f-7deb-45f8-913f-7fdff4abbebe",
        "name": "Johna Linskey",
        "picture": null,
        "email": "johna.linskey@yopmail.com",
        "displayName": "Johna Linskey"
      },
      "points_expiration": {
        "expiration_date": "2022-05-07T07:30:23.749Z",
        "expiring_points_amount": 5
      }
    },
    {
      "id": "73618276-35cc-4d21-8380-bdd2fbebf781",
      "contactId": "fb8f125e-bfc3-4d9a-80c2-215494f24731",
      "memberId": "ddd5302e-23cf-4fd6-bf6b-461aaae3ab7d",
      "points": {
        "balance": 25,
        "earned": 30,
        "redeemed": 5,
        "adjusted": 0
      },
      "rewardAvailable": true,
      "createdDate": "2021-12-06T14:33:19.114Z",
      "updatedDate": "2021-12-07T07:30:23.749Z",
      "revision": "4",
      "tier": {
        "id": null,
        "updatedDate": "2021-12-07T07:30:23.749Z",
        "recalculationDate": null,
        "points": 30
      },
      "lastActivityDate": "2021-12-07T07:30:23.749Z",
      "contact": {
        "id": "7728152f-7deb-45f8-913f-7fdff4abbebe",
        "name": "Aigneis Johnsson",
        "picture": null,
        "email": "aigneis.johnsson@yopmail.com",
        "displayName": "Aigneis Johnsson"
      },
      "points_expiration": {
        "expiration_date": "2022-05-07T07:30:23.749Z",
        "expiring_points_amount": 5
      }
    }
  ],
  "pagingMetadata": {
    "count": 2,
    "offset": null,
    "total": 2,
    "tooManyToCount": null,
    "cursors": {
      "next": null,
      "prev": null
    }
  }
}

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?