# List Benefits

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/benefits:
    get:
      summary: List Benefits
      deprecated: false
      description: >-
        Returns list of [Benefits](doc-341690#benefit-model).


        ## Query Parameters


        | Parameter     | Type    | Default |
        Description                                                       |

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

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

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

        | with_archived | boolean | false   | When true, also archived records
        will be returned                 |


        ## Response Body


        | Key             | Type                |
        Description                                   |

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

        | benefits        | object[]            | List of [Benefits](doc-341690)
        |

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


        ## Example


        ```shell

        curl -X GET \

        "https://api.mpc.placewise.com/v1/benefits" \
          -H 'x-client-authorization: B7t9U9tsoWsGhrv2ouUoSqpM' \
          -H 'x-loyalty-club-slug: infinity-mall' \
          -H 'x-product-name: default' \
          -H 'x-user-agent: CURL manual test'
        ```


        When successful, returns object containing
        [Benefits](doc-341690#benefit-model) and [PaginationInfo](doc-341638)


        ```json

        {
          "benefits": [], // List of Benefits - see 'Benefit model'
          "pagination_info": {} // Pagination info - see 'Pagination info'
        }

        ```
      tags:
        - API Reference/Management API/Members/Benefits
      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/Benefits
      x-apidog-status: pending
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511038-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```