# List Member Groups

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v3/{loyalty_club_slug}/members_groups:
    get:
      summary: List Member Groups
      deprecated: false
      description: >-
        Returns groups defined within Loyalty Club.


        ## Query Parameters


        | Parameter     | Type      | Default | Description

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

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

        | page_no       | integer   | 1 | Number of results page

        | name          | string    | null | When given, returns only group of
        given name

        | type          | string    | null | When given, returns only groups of
        given type

        | automatic     | boolean   | null | When true, only automatic groups
        are returned, when false - only manual

        | system        | boolean   | null | When true, only system groups are
        returned, when false - only non-system

        | ids           | integer[] | null | When given, returns only groups
        with the given ids

        | audiences_ids | integer[] | null | When given, returns only automatic
        groups for given audiences

        | search        | string    | null | When given, returns only groups
        that have name, type or description matching the query string


        ## Response Body


        Key | Type | Description

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

        members_groups | MembersGroup[] | Array of
        [MembersGroup](doc-341688#membersgroup-model)

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


        ## Example


        ```shell

        curl --request GET
        'https://api.mpc.placewise.com/v3/infinity-mall/members_groups' \

        --header 'x-client-authorization: B7t9U9tsoWsGhrv2ouUoSqpM' \

        --header 'x-product-name: default' \

        --header 'x-user-agent: cURL Manual Testing'

        ```


        When successful, returns object containing [members
        groups](doc-341688#membersgroup-model) and [PaginationInfo](doc-341638)


        ```json

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

        ```
      tags:
        - API Reference/Management API/Members/Groups/Groups
      parameters:
        - name: loyalty_club_slug
          in: path
          description: ''
          required: true
          example: infinity-mall
          schema:
            type: string
        - name: name
          in: query
          description: When given, returns only group of given name
          required: false
          example: Espresso House
          schema:
            type: string
        - name: type
          in: query
          description: When given, returns only groups of given type
          required: false
          example: Store
          schema:
            type: string
        - name: automatic
          in: query
          description: >-
            When true, only automatic groups are returned, when false - only
            manual
          required: false
          example: 'true'
          schema:
            type: boolean
        - name: system
          in: query
          description: >-
            When true, only system groups are returned, when false - only
            non-system
          required: false
          example: 'true'
          schema:
            type: boolean
        - name: ids
          in: query
          description: When given, returns only groups with the given ids
          required: false
          example:
            - '1'
          schema:
            type: array
            items:
              type: string
        - name: audiences_ids
          in: query
          description: When given, returns only automatic groups for given audiences
          required: false
          example:
            - '1'
          schema:
            type: array
            items:
              type: string
        - name: search
          in: query
          description: >-
            When given, returns only groups that have name, type or description
            matching the query string
          required: false
          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/Groups/Groups
      x-apidog-status: pending
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3511026-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```