search-loyalty-accounts-request.md

Search Loyalty Accounts Request

A request to search for loyalty accounts.

Structure

SearchLoyaltyAccountsRequest

Fields

Name	Type	Tags	Description
query	SearchLoyaltyAccountsRequestLoyaltyAccountQuery | undefined	Optional	The search criteria for the loyalty accounts.
limit	number | undefined	Optional	The maximum number of results to include in the response. The default value is 30. Constraints: >= 1, <= 200
cursor	string | undefined	Optional	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. For more information, see Pagination.

Example (as JSON)

{
  "limit": 10,
  "query": {
    "mappings": [
      {
        "phone_number": "+14155551234",
        "id": "id8",
        "created_at": "created_at6"
      }
    ],
    "customer_ids": [
      "customer_ids1",
      "customer_ids2",
      "customer_ids3"
    ]
  },
  "cursor": "cursor0"
}