# List Members By Audience

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/audience_members:
    post:
      summary: List Members By Audience
      deprecated: false
      description: >-
        Returns list of Loyalty Club members by `audience_id` or
        `audience_conditions`.


        ## Body Parameters


        | Parameter           |
        Type                                                            |
        Required? | Default |
        Description                                                                                                                                           

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

        | audience_id         |
        integer                                                         |
        no        | null    | When present, only members from given Audience
        will be returned See [DMP
        docs](https://dmp.boostcom.no/docs/#audience-api-conditions)                 

        | audience_conditions |
        object[]                                                        |
        no        | null    | When present, only members matching given audience
        conditions will be returned. See [DMP
        docs](https://dmp.boostcom.no/docs/#audience-api-conditions) 

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

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

        | sort_by             | enum: `id, msisdn, email, full_name, created_at,
        optin_channel` | no        | 'id'    |

        | sort_direction      | enum: `asc,
        desc`                                               | no        |
        'asc'   |


        When `audience_id` is not present, all members are returned.


        When `audience_conditions` are given along with `audience_id`, they're
        appended to the given audience conditions.


        ## Response Body


        | Key             | Type          |
        Description                            

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

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

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


        ## Example


        ```shell

        curl -X POST "https://api.mpc.placewise.com/v1/audience_members" \
          -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"
        }


        ```
      tags:
        - API Reference/Management API/Members/Listing Members
      parameters:
        - 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-3510970-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```