# List RAF Campaigns

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/refer_a_friend/management/campaigns:
    get:
      summary: List RAF Campaigns
      deprecated: false
      description: |+
        List RAF campaigns

      tags:
        - API Reference/Management API/Members/Refer a Friend
      parameters:
        - name: search
          in: query
          description: search campaign by name
          required: false
          schema:
            type: string
        - 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: with_archived
          in: query
          description: When true, also archived record will be treated as accessible
          example: 'false'
          schema:
            type: boolean
            default: 'false'
        - name: only_archived
          in: query
          description: When true, only archived record will be treated as accessible
          example: 'false'
          schema:
            type: boolean
            default: 'false'
        - 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: array
                items:
                  $ref: '#/components/schemas/ReferAFriendCampaign'
              example:
                - id: 77722646
                  name: Julius Wilkinson
                  starts_at: '2022-11-09T16:25:58.099512Z'
                  ends_at: '2022-11-09T16:25:58.099512Z'
                  required_registered_members_count: 1
                  status: invactive
                  source: sunt enim
                  subsource: esse minim quis
                  offer_id: 21892781
                  consents:
                    en: Text
                  decription:
                    en: Text
                  link_button:
                    en: Text
                  share_button:
                    en: Text
                  info_title:
                    en: Text
                  info_text:
                    en: Text
                  success_title:
                    en: Text
                  success_text:
                    en: Text
                  recruited_count: 1
                  winner_count: 1
                  thumbnail: null
                  created_at: '2022-11-05T16:25:58.099512Z'
                  updated_at: '2022-11-15T16:25:58.099512Z'
                - id: 24907659
                  name: Cornelius Jenkins
                  starts_at: '2022-11-09T16:25:58.099512Z'
                  ends_at: '2022-11-09T16:25:58.099512Z'
                  required_registered_members_count: 2
                  status: draft
                  source: consectetur Ut ut sed
                  subsource: qui
                  offer_id: 16596579
                  consents:
                    en: Text
                  decription:
                    en: Text
                  link_button:
                    en: Text
                  share_button:
                    en: Text
                  info_title:
                    en: Text
                  info_text:
                    en: Text
                  success_title:
                    en: Text
                  success_text:
                    en: Text
                  recruited_count: 1
                  winner_count: 0
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: API Reference/Management API/Members/Refer a Friend
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-4061344-run
components:
  schemas:
    ReferAFriendCampaign:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
          description: campaign id
        name:
          type: string
          description: title
        starts_at: &ref_0
          $ref: '#/components/schemas/date_time'
          description: when campaigns starts
        ends_at: *ref_0
        required_registered_members_count:
          type: integer
          minimum: 1
          description: >-
            how many members must register through referer linkt for him to get
            offer
        status:
          type: string
          enum:
            - active
            - invactive
            - draft
          x-apidog-enum:
            - value: active
              name: ''
              description: ''
            - value: invactive
              name: ''
              description: ''
            - value: draft
              name: ''
              description: ''
        source:
          type: string
          description: source/product used during member registration
        subsource:
          type: string
          description: subsource used during member regitration
          nullable: true
        offer_id:
          type: integer
          minimum: 1
          description: offer ID
        consents: &ref_1
          $ref: '#/components/schemas/LocalizedContent'
          description: campaign contests
        decription: *ref_1
        link_button: *ref_1
        share_button: *ref_1
        info_title: *ref_1
        info_text: *ref_1
        success_title: *ref_1
        success_text: *ref_1
        recruited_count:
          type: integer
          description: number of mebers recruited through campaigns
          minimum: 0
        winner_count:
          type: integer
          description: >-
            number of members which succesfully completed campaign conditions
            and get prize
          minimum: 0
        thumbnail:
          $ref: '#/components/schemas/File'
        created_at:
          $ref: '#/components/schemas/date_time.created_at'
        updated_at:
          $ref: '#/components/schemas/date_time.updated_at'
      x-apidog-orders:
        - id
        - name
        - starts_at
        - ends_at
        - required_registered_members_count
        - status
        - source
        - subsource
        - offer_id
        - consents
        - decription
        - link_button
        - share_button
        - info_title
        - info_text
        - success_title
        - success_text
        - recruited_count
        - winner_count
        - thumbnail
        - created_at
        - updated_at
      required:
        - id
        - name
        - starts_at
        - ends_at
        - required_registered_members_count
        - status
        - source
        - offer_id
        - consents
        - decription
        - link_button
        - share_button
        - info_title
        - info_text
        - success_title
        - success_text
        - recruited_count
        - winner_count
        - thumbnail
        - created_at
        - updated_at
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    date_time.updated_at:
      type: string
      description: Time of the last record update
      format: date-time
      examples:
        - '2022-11-15T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    date_time.created_at:
      type: string
      description: Time of record creation
      format: date-time
      examples:
        - '2022-11-05T16:25:58.099512Z'
      readOnly: true
      x-apidog-folder: ''
    File:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          examples:
            - https://example.com/image.png
        identifier:
          type: string
          description: Only present when parent record has many files
          examples:
            - '1'
        mime_type:
          type: string
          examples:
            - image/jpeg
          readOnly: true
          description: Only present in certain circumstances
          nullable: true
        created_at:
          type: string
          format: date-time
          examples:
            - '2022-11-09T15:46:00.252860Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          examples:
            - '2022-11-09T15:46:00.252860Z'
        image_details:
          type: object
          properties:
            width:
              type: integer
              minimum: 1
            height:
              type: integer
              minimum: 1
          x-apidog-orders:
            - width
            - height
          x-apidog-ignore-properties: []
          nullable: true
      x-apidog-orders:
        - url
        - identifier
        - mime_type
        - created_at
        - updated_at
        - image_details
      required:
        - url
        - created_at
        - updated_at
      readOnly: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    LocalizedContent:
      type: object
      properties: {}
      x-apidog-orders: []
      title: ''
      examples:
        - en: Text
      additionalProperties:
        type: string
        description: >-
          The actual set of languages depends on LC configuration. See:
          [Localization](doc-341959)
        examples:
          - Tekst
        nullable: true
      x-apidog-ignore-properties: []
      nullable: true
      x-apidog-folder: ''
    date_time:
      type: string
      format: date-time
      examples:
        - '2022-11-09T16:25:58.099512Z'
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```