List Members

GET

/api/Members

curl --request GET \
  --url 'https://example.com/api/Members?Status=Active' \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of members for a merchant. Supports optional free-text search across name and email, and filtering by status.

GET /api/members?merchantId=...&search=smith&page=1&pageSize=20

Authorizations

• Bearer

Parameters

Query Parameters

MerchantId

string format: uuid

Search

string

Status

string

Allowed values: Active Paused Cancelled

Page

integer format: int32

PageSize

integer format: int32

Responses

200

Paginated list of members.

Media type application/json

object

items

Array<object>

nullable

object

id

string format: uuid

firstName

string

nullable

lastName

string

nullable

fullName

string

nullable

email

string

nullable

phone

string

nullable

status

string

Allowed values: Active Paused Cancelled

createdAt

string format: date-time

plans

Array<object>

nullable

object

name

string

nullable

price

number format: double

frequency

string

Allowed values: OneOff Daily Weekly Fortnightly Monthly Quarterly Yearly

lifetimeValue

number format: double

nextBillingDate

string format: date-time

nullable

nextBillingAmount

number format: double

nullable

paymentMethod

object

type

string

Allowed values: Card BankAccount

last4

string

nullable

brand

string

nullable

expiryMonth

integer format: int32

nullable

expiryYear

integer format: int32

nullable

accountName

string

nullable

bsb

string

nullable

page

integer format: int32

pageSize

integer format: int32

totalCount

integer format: int32

totalPages

integer format: int32

hasNextPage

boolean

hasPreviousPage

boolean

Example

{
  "items": [
    {
      "status": "Active",
      "plans": [
        {
          "frequency": "OneOff"
        }
      ],
      "paymentMethod": {
        "type": "Card"
      }
    }
  ]
}