# List Member Benefits

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/members/me/benefits:
    get:
      summary: List Member Benefits
      deprecated: false
      description: >-
        Returns list of [Benefits](doc-341690) available in Loyalty Club with
        the information if they're active for member.
          
        It's sortable by all the attributes except for `active`.
      tags:
        - API Reference/Public API/Member/Benefits
      parameters:
        - name: active
          in: query
          description: >-
            When `true`, it returns only active Benefits. When `false`, only
            inactive.
          required: false
          example: 'true'
          schema:
            type: boolean
        - name: type
          in: query
          description: ''
          required: false
          schema:
            type: string
            enum:
              - generic
              - benefit
            x-apidog-enum:
              - value: generic
                name: ''
                description: ''
              - value: benefit
                name: ''
                description: ''
        - name: per_page
          in: query
          description: >-
            Number of results to be returned per request. See: [API
            Pagination](doc-341638)
          example: 10
          schema:
            type: integer
            default: '10'
        - name: page_no
          in: query
          description: 'Number of results page. See: [API Pagination](doc-341638)'
          example: 1
          schema:
            type: integer
            minimum: 1
            default: '1'
        - name: sort_by[]
          in: query
          description: 'See: [Sorting params](doc-341639)'
          example: id
          schema:
            type: string
            default: id
        - name: sort_directions[]
          in: query
          description: 'See: [Sorting params](doc-341639)'
          example: DESC
          schema:
            type: string
            enum:
              - ASC
              - DESC
            examples:
              - ASC
              - DESC
            default: DESC
            x-apidog-enum:
              - value: ASC
                name: ''
                description: ''
              - value: DESC
                name: ''
                description: ''
        - 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: 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}}'
        - name: X-Locale
          in: header
          description: Desired content language. [Details](doc-341959)
          required: false
          example: '{{LOCALE}}'
          schema:
            type: string
            default: '{{LOCALE}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  benefits:
                    type: array
                    items:
                      $ref: '#/components/schemas/MemberBenefit'
                  pagination_info:
                    $ref: '#/components/schemas/PaginationInfo'
                x-apidog-orders:
                  - benefits
                  - pagination_info
                required:
                  - benefits
                  - pagination_info
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Public API/Member/Benefits
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3510844-run
components:
  schemas:
    PaginationInfo:
      type: object
      properties:
        count:
          type: integer
          description: Actual number of results returned in request
          readOnly: true
          examples:
            - 1000
        total_count:
          type: integer
          description: Number of all available results
          minimum: 1
          examples:
            - 2050
        per_page:
          type: integer
          description: Number of results returned per request
          readOnly: true
          examples:
            - 1000
        total_pages:
          type: integer
          description: Number of all available pages
          readOnly: true
          examples:
            - 3
        current_page:
          type: integer
          readOnly: true
          examples:
            - 1
        next_page:
          type: integer
          description: Next available page (null when it's a last page)
          readOnly: true
          examples:
            - 2
          nullable: true
        prev_page:
          type: integer
          description: Next available page (null when it's a first page)
          readOnly: true
          examples:
            - null
          nullable: true
        is_first_page:
          type: boolean
          readOnly: true
          examples:
            - true
        is_last_page:
          type: boolean
          readOnly: true
          examples:
            - false
        is_out_of_range:
          type: boolean
          description: Is given `per_page` param out of range?
          readOnly: true
          examples:
            - false
        offset:
          type: integer
          readOnly: true
          examples:
            - 0
      required:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      x-apidog-orders:
        - count
        - total_count
        - per_page
        - total_pages
        - current_page
        - next_page
        - prev_page
        - is_first_page
        - is_last_page
        - is_out_of_range
        - offset
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    MemberBenefit:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/id'
        type:
          $ref: '#/components/schemas/MemberBenefitType'
        identifier:
          type: string
          examples:
            - my_program_1
        name:
          type: string
          description: Depends on [X-Locale header](doc-341635#x-locale-header)
          examples:
            - Name
          nullable: true
        description:
          type: string
          description: Depends on [X-Locale header](doc-341635#x-locale-header)
          examples:
            - Description
          nullable: true
        conditions:
          type: string
          description: >-
            Describes conditions of the benefit. May contain HTML. Depends on
            [X-Locale header](doc-341635#x-locale-header)
          examples:
            - Conditions
          nullable: true
        active:
          type: boolean
          description: >-
            True when benefit is active for member (its conditions are
            fulfilled)
      required:
        - id
        - type
        - identifier
        - name
        - description
        - conditions
        - active
      x-apidog-orders:
        - id
        - type
        - identifier
        - name
        - description
        - conditions
        - active
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    MemberBenefitType:
      type: string
      enum:
        - generic
        - parking
      x-apidog-enum:
        - value: generic
          name: ''
          description: ''
        - value: parking
          name: ''
          description: ''
      examples:
        - generic
        - parking
      x-apidog-folder: ''
    id:
      type: integer
      description: Primary identifier of the record
      format: uint64
      readOnly: true
      examples:
        - 1
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```