---
title: "List Members"
method: GET
path: "/open-api/v1.1/memberships/members"
tags: ["Members"]
---

# List Members

`GET /open-api/v1.1/memberships/members`

## Query parameters

- `page` integer
- `limit` integer
- `search_query` string
- `tier_ids[]` integer[]
- `intervals[]` string[]
- `states[]` string[]
- `member_ids[]` integer[]
- `gifted_by_others` boolean

## Headers

- `X-ShopId` string

## Response `200`

- ResponseV1Members
  - `members` ResponseV1Member[], required
    - `id` integer, required
    - `nickname` string, required
    - `email` string, required
    - `avatarUrl` string
    - `tier` ResponseV1MemberTier
      - `name` string, required
      - `billingCycle` 'Monthly' | 'Annual', required
      - `askForShippingAddress` boolean, required
    - `state` union, required
      - ResponseV1MemberStateActive
        - `type` 'Active'
        - `subscribedAt` string, date-time, required
        - `freeTrialEndsAt` string, date-time
      - ResponseV1MemberStateExpiring
        - `type` 'Expiring'
        - `subscribedAt` string, date-time, required
        - `expiresAt` string, date-time, required
        - `freeTrialEndsAt` string, date-time
      - ResponseV1MemberStateNone
        - `type` 'None'
      - ResponseV1MemberStatePastDue
        - `type` 'PastDue'
        - `subscribedAt` string, date-time, required
        - `previousPeriodEnd` string, date-time, required
      - ResponseV1MemberStateFormer
        - `type` 'Former'
        - `subscribedAt` string, date-time, required
        - `expiredAt` string, date-time, required
    - `joinedAt` string, date-time, required
    - `accountOrigin` 'Checkout' | 'FreeAccount'
    - `shadowBanned` boolean, required
    - `conversationId` integer
    - `cancelRequest` union, required
      - object
        - `type` 'Allowed', required
        - `subscriptionCurrentPeriodEnd` string, date-time, required
      - object
        - `type` 'Disabled', required
        - `reason` 'SubscriptionNotActive' | 'AlreadyRequested' | 'IapSubscription', required
    - `badges` ResponseV1MemberBadgesBadge[]
      - `id` integer, required
      - `emojiIcon` string
      - `icon` union, required
        - object
          - `type` 'Emoji', required
          - `emojiIcon` string, required
        - object
          - `type` 'ImageResource', required
          - `url` string, required
      - `text` string, required
      - `textColor` string
      - `backgroundColor` string
      - `borderColor` string
      - `assignedAt` string, date-time, required
      - `minimal` boolean, required
    - `wantsToReceiveBenefits` boolean
    - `shippingAddress` ResponseV1MemberAddressesShipping
      - `name` string, required
      - `address1` string, required
      - `address2` string
      - `city` string, required
      - `state` string
      - `zip` string
      - `country` string, required
      - `phone` string
      - `vatId` string
    - `creatorNotes` ResponseV1MemberCreatorNotes, required
      - `note` string, nullable
  - `pagination` ResponseV1Pagination, required
    - `pages` integer, required
    - `limit` integer, required
    - `page` integer, required
    - `total` integer

## Other responses

- `400`

---

[API](https://skmtc.dev/fourthwall/apis/openapi.md) · [All operations](https://skmtc.dev/fourthwall/apis/openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fourthwall/openapi/revisions/c6887a2f069b/schema)