Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.01 KB

search-loyalty-accounts-request.md

File metadata and controls

32 lines (23 loc) · 1.01 KB

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, <= 30
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"
      }
    ]
  }
}