# List Members

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v3/{loyalty_club_slug}/members:
    get:
      summary: List Members
      deprecated: false
      description: >-
        Returns list of Loyalty Club members.


        ## Query Parameters


        | Parameter                  | Type      | Required? | Default |
        Description                                                                                                                                                                                                          

        |----------------------------|-----------|-----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

        | per_page                   | integer   | no        | 1000    | Number
        of results to be returned per request (1000 is the
        maximum)                                                                                                                                                   

        | page_no                    | integer   | no        | 1       | Number
        of results
        page                                                                                                                                                                                               

        | ids                        | integer[] | no        | null    | When
        present, only members with given IDs will be
        returned                                                                                                                                                           

        | properties.<property_name> | string[]  | no        | null    | When
        present, only members with given properties will be returned. A property
        must be enabled for querying in the Loyalty Club configuration before it
        can be used here. Please contact us if you need this feature. 

        | store_ids                  | integer[] | no        | null    | When
        present, only members having at least one of given stores will be
        returned                                                                                                                                      

        | search                     | string    | no        | null    | When
        present, only members matching the query will be
        returned                                                                                                                                                       

        | sort_by                    | string[]  | no        | null    | See:
        [Sorting
        params](doc-341639)                                                                                                                                                                         

        | sort_directions            | string[]  | no        | null    | See:
        [Sorting params](doc-341639)


        ## Response Body


        | Key             | Type          |
        Description                            

        -----------------|---------------|----------------------------------------

        | members         | Member[] | Array of
        [Members](doc-342131#member)      

        | pagination_info | Object        | [Pagination](doc-341638) object


        ## Error Responses


        Status | Reason

        --------|----------------------------------- 
         `422`  | :per_page param exceeds the limit

        ## Example


        ```shell

        curl
        "https://api.mpc.placewise.com/v3/infinity-mall/members?per_page=100&page_no=1&ids[]=1&ids[]=2"
        \
          -H 'content-type: application/json' \
          -H 'x-client-authorization: B7t9U9tsoWsGhrv2ouUoSqpM' \
          -H 'x-product-name: default' \
          -H 'x-user-agent: CURL manual test'
        ```


        When successful, returns object containing [members](doc-342131#member)
        and [PaginationInfo](doc-341638)


        ```json

        {
          "members": [], // List of members - see 'Member model'
          "pagination_info": {} // Pagination info - see 'Pagination info"
        }


        ```


        ### Other example queries


        *
        `/members?properties[gender]=man&properties[language][]=en&properties[language][]=pl`
        - returns members with `gender="man" AND language IN ("en", "pl")`

        * `/members?ids[]=1&ids[]=2` - returns members with `id IN (1, 2)`
      tags:
        - API Reference/Management API/Members/Listing Members
      parameters:
        - name: loyalty_club_slug
          in: path
          description: ''
          required: true
          example: infinity-mall
          schema:
            type: string
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Management API/Members/Listing Members
      x-apidog-status: pending
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3510969-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```