---
title: "Get members (with filters)"
method: POST
path: "/api/v2/host/members/list"
tags: ["host"]
---

# Get members (with filters)

`POST /api/v2/host/members/list`

## Request body

- ApiV2HostMembersListRequestWithFilterDto
  - `page` integer, required — Starts at 0
  - `pageSize` integer, required
  - `sortOrder` 'ASC' | 'DESC'
  - `sortBy` 'lastSeenAt' | 'firstSeenAt' | 'firstName' | 'lastName' | 'email' — Field to sort by
  - `query` string — Search customers by query
  - `filterPreset` 'with-active-membership'
  - `staticSegmentId` integer — Filter customers by static segment ID
  - `filter` HostCustomersListFilterDto
    - `type` 'and' | 'or', required
    - `joinedSince` string
    - `lastContacted` LastContactedDto
      - `type` 'fixed' | 'flexible', required
      - `startDate` string, nullable
      - `endDate` string, nullable
      - `days` integer
    - `visits` VisitsDto
      - `count` SessionsCountDto, required
        - `type` 'moreThan' | 'lessThan' | 'exactly', required
        - `value` integer, required
      - `startDate` string, nullable
      - `endDate` string, nullable
      - `dateType` 'fixed' | 'flexible'
      - `timeUnitNumber` integer
      - `qualifiers` VisitsQualifiersDto
        - `membershipIds` MembershipIdDto[]
          - `membershipId` integer, required
        - `teacherIds` TeacherIdDto[]
          - `teacherId` integer, required
        - `sessionIds` SessionIdDto[]
          - `sessionId` integer, required
        - `templateIds` TemplateIdDto[]
          - `templateId` integer, required
        - `sessionSeriesIds` SessionSeriesIdDto[]
          - `seriesId` integer, required
        - `locationIds` LocationIdDto[]
          - `locationId` integer, required
        - `sessionType` 'private' | 'special-event' | 'special-event-new' | 'retreat' | 'fitness' | 'course' | 'course-class' | 'semester' | 'recital'
        - `appointmentServiceIds` AppointmentServiceIdDto[]
          - `appointmentServiceId` integer, required
    - `address` AddressDto
      - `address` string
      - `city` string
      - `country` string
      - `zipcode` string
    - `futureBookings` FutureBookingsDto
      - `count` FutureBookingsCountDto, required
        - `type` 'moreThan' | 'lessThan' | 'exactly', required
        - `value` integer, required
      - `dateType` 'fixed' | 'flexible'
      - `startDate` string, nullable
      - `endDate` string, nullable
      - `timeUnit` 'days' | 'weeks' | 'months'
      - `timeUnitNumber` integer
    - `memberships` MembershipFilterDto[]
      - `membershipState` 'active' | 'not-active' | 'cancelled' | 'expired' | 'none', required
      - `membershipId` integer, nullable
      - `membershipIds` integer[]
    - `customerAge` CustomerAgeDto
      - `fieldId` integer, required
      - `type` 'after' | 'before' | 'on' | 'between' | 'isEmpty' | 'isNotEmpty', required
      - `value` integer
      - `value2` integer
    - `customFields` CustomFieldsDto
      - `date` CustomDateFieldDto[]
        - `fieldId` integer, required
        - `type` 'after' | 'before' | 'on' | 'between' | 'isEmpty' | 'isNotEmpty', required
        - `value` string
        - `value2` string
        - `yearExcluded` boolean
      - `number` CustomNumberFieldDto[]
        - `fieldId` integer, required
        - `type` 'largerThan' | 'smallerThan' | 'equalsTo' | 'isEmpty' | 'isNotEmpty', required
        - `value` integer, nullable, required
      - `text` CustomTextFieldDto[]
        - `fieldId` integer, required
        - `type` 'includes' | 'equalsTo' | 'isEmpty' | 'isNotEmpty', required
        - `value` string
      - `dropdown` CustomDropdownFieldDto[]
        - `fieldId` integer, required
        - `type` 'equalsTo' | 'isEmpty' | 'isNotEmpty', required
        - `value` string, nullable
      - `boolean` CustomBooleanFieldDto[]
        - `fieldId` integer, required
        - `value` string, required
    - `customerTags` CustomerTagsDto
      - `type` 'and' | 'or', nullable, required
      - `tags` integer[], required
      - `customerHaveTag` 'have' | 'not-have'
    - `homeLocations` HomeLocationDto[]
      - `locationId` integer, nullable, required
    - `parentsChildren` string[]
    - `customerRankings` CustomerRankingsDto
      - `customerRankingId` integer, required
      - `customerHaveRanking` 'have' | 'not-have'

## Response `200`

- object
  - `pagination` PaginatedResponseDataDto, required
    - `page` integer, required
    - `pageSize` integer, required
    - `totalCount` integer, required
    - `sortBy` string
    - `sortOrder` 'ASC' | 'DESC'
  - `payload` HostMemberDto[], required
    - `id` integer, required
    - `firstName` string, required
    - `lastName` string, required
    - `email` string, required
    - `phoneNumber` string, nullable, required
    - `pictureUrl` string, nullable, required
    - `firstSeen` string, date-time, required
    - `lastSeen` string, date-time, required
    - `visits` MemberVisitsDto, required
      - `appointments` integer, required — All the appointments the customer has booked
      - `appointmentsVisits` integer, required — All the appointments the customer has booked and checked into
      - `bookings` integer, required — All the session bookings the customer has booked
      - `bookingsVisits` integer, required — All the session bookings the customer has booked and checked into
      - `openAreaVisits` integer, required — All visits of open areas for customer
      - `total` integer, required — Combined count of appointments + bookings
      - `totalVisits` integer, required — Combined count of appointmentsVisits + bookingsVisits
    - `customerFields` HostMemberCustomerFieldDto[], required
      - `id` integer, required — ID of the customer field
      - `label` string, required — label of the customer field
      - `type` 'text' | 'number' | 'date' | 'date-time' | 'dropdown' | 'boolean' | 'date-of-birth', required — type of the customer field
      - `value` string, required — value set for the member for this customer field
    - `customerTags` HostTagDto[], required
      - `id` integer, required
      - `name` string, required
      - `isCustomerBadge` boolean, required
      - `badgeLabel` string, nullable, required
      - `badgeColor` string, nullable, required
      - `corporateTagId` integer, nullable, required

---

[API](https://skmtc.net/momence/apis/momence-public.md) · [All operations](https://skmtc.net/momence/apis/momence-public/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/momence/momence-public/revisions/5e27e54ff467/schema)