---
title: "Search members"
method: POST
path: "/members/search"
tags: ["Members"]
---

# Search members

`POST /members/search`

Search members based on customer information provided by Mews PMS.

Mews PMS will use this operation to display existing members based on customer-provided data. All available customer data is sent.

## Headers

- `Accept-Language` string

## Request body

- SearchMembersRequest — Request payload for searching loyalty program members based on customer information from Mews PMS.
  - `mewsEnterpriseId` string, uuid, required — The identifier of the Mews enterprise on whose behalf the request has been made.
  - `providerEnterpriseId` string — An optional identifier of the enterprise from the loyalty provider on whose behalf the request has been made.
  - `memberFilter` union, required — Filter criteria for searching loyalty members. At least one valid filter combination must be provided.
    - object
      - `providerMembershipId` string — Unique identifier for the membership in the provider's system.
      - `membershipNumber` string — Membership number assigned by the loyalty program.
      - `email` string, email, required — Customer's email address for searching.
      - `firstName` string — Customer's first name for searching.
      - `lastName` string — Customer's last name for searching.
      - `phoneNumber` string — Customer's phone number for searching.
      - `city` string — Customer's city.
      - `postalCode` string — Customer's postal code.
      - `countryCode` string — ISO 3166-1 code of the country.
    - object
      - `providerMembershipId` string — Unique identifier for the membership in the provider's system.
      - `membershipNumber` string, required — Membership number assigned by the loyalty program.
      - `email` string, email — Customer's email address for searching.
      - `firstName` string — Customer's first name for searching.
      - `lastName` string — Customer's last name for searching.
      - `phoneNumber` string — Customer's phone number for searching.
      - `city` string — Customer's city.
      - `postalCode` string — Customer's postal code.
      - `countryCode` string — ISO 3166-1 code of the country.
    - object
      - `providerMembershipId` string, required — Unique identifier for the membership in the provider's system.
      - `membershipNumber` string — Membership number assigned by the loyalty program.
      - `email` string, email — Customer's email address for searching.
      - `firstName` string — Customer's first name for searching.
      - `lastName` string — Customer's last name for searching.
      - `phoneNumber` string — Customer's phone number for searching.
      - `city` string — Customer's city.
      - `postalCode` string — Customer's postal code.
      - `countryCode` string — ISO 3166-1 code of the country.
    - object
      - `providerMembershipId` string — Unique identifier for the membership in the provider's system.
      - `membershipNumber` string — Membership number assigned by the loyalty program.
      - `email` string, email — Customer's email address for searching.
      - `firstName` string, required — Customer's first name for searching.
      - `lastName` string, required — Customer's last name for searching.
      - `phoneNumber` string — Customer's phone number for searching.
      - `city` string — Customer's city.
      - `postalCode` string — Customer's postal code.
      - `countryCode` string — ISO 3166-1 code of the country.
    - object
      - `providerMembershipId` string — Unique identifier for the membership in the provider's system.
      - `membershipNumber` string — Membership number assigned by the loyalty program.
      - `email` string, email — Customer's email address for searching.
      - `firstName` string — Customer's first name for searching.
      - `lastName` string, required — Customer's last name for searching.
      - `phoneNumber` string — Customer's phone number for searching.
      - `city` string, required — Customer's city.
      - `postalCode` string — Customer's postal code.
      - `countryCode` string, required — ISO 3166-1 code of the country.

## Response `200`

Search result with list of matching members.

- SearchMembersResponse — Response payload containing search results with matching loyalty program members.
  - `isPartialResult` boolean, required — If the number of matching results exceeds the allowed maximum number of result items (10), set `isPartialResult` to `true` to indicate an incomplete result set.
  - `data` Member[], required — Array of matching members.
    - `firstName` string, required
    - `lastName` string, required
    - `email` string, email
    - `birthday` string, date — User's date of birth in ISO 8601 format (YYYY-MM-DD)
    - `phoneNumber` string
    - `address` Address — Physical address information including street address, city, postal code, and country details.
      - `line1` string
      - `line2` string
      - `city` string
      - `postalCode` string
      - `countryCode` string
      - `countrySubdivisionCode` string
    - `membership` SearchMembership, required — Contains membership information including provider membership ID, membership number, tier, points, and current status.
      - `providerMembershipId` string, required — Unique internal identifier of membership from the loyalty provider. Can be the same as `membershipNumber` if no other value is needed.
      - `membershipNumber` string, required — Member code or number, typically on loyalty card.
      - `tier` string
      - `points` integer
      - `status` 'pending' | 'enrolled' | 'canceled' | 'declined', required
      - `expiresAt` string, date-time
      - `deeplinkUrl` string, uri

## Other responses

- `400` — Bad Request - Returned when the request is invalid, such as missing required fields or containing data in an incorrect format (e.g., an improperly formatted email).
- `401` — Unauthorized
- `408` — Request Timeout
- `422` — Unprocessable Content - Used when the request is syntactically valid but fails due to business logic constraints, such as required parameter combinations or insufficient search parameters.
- `500` — Internal Server Error

---

[API](https://skmtc.net/mews/apis/pos-api.md) · [All operations](https://skmtc.net/mews/apis/pos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/pos-api/versions/33ecaa6c7266/schema)