# List codebreaker campaigns

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/management/games/codebreaker/campaigns:
    get:
      summary: List codebreaker campaigns
      deprecated: false
      description: List games campaigns of type "codebreaker"
      tags:
        - API Reference/Management API/Games/Codebreaker
      parameters:
        - name: status
          in: query
          description: When present, only records of given status will be returned
          required: false
          example: draft
          schema:
            type: string
            default: 'null'
            enum:
              - draft
              - active
              - inactive
            x-apidog-enum:
              - name: ''
                value: draft
                description: ''
              - name: ''
                value: active
                description: ''
              - name: ''
                value: inactive
                description: ''
        - name: search
          in: query
          description: minimum 3 characters
          required: false
          schema:
            type: string
            minLength: 3
        - 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}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  campaigns:
                    type: array
                    items:
                      x-apidog-refs: {}
                      x-apidog-orders:
                        - id
                        - name
                        - starts_at
                        - ends_at
                        - status
                        - code_length
                        - member_frequency
                        - webpage_url
                        - codes
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        starts_at:
                          type: string
                          x-apidog-mock: '{{$date.timestamp|format(''yyyy-MM-dd'')}}'
                        ends_at:
                          type: string
                          x-apidog-mock: '{{$date.timestamp|format(''yyyy-MM-dd'')}}'
                        status:
                          type: string
                          enum:
                            - draft
                            - active
                            - inactive
                          x-apidog-enum:
                            - value: draft
                              name: ''
                              description: ''
                            - value: active
                              name: ''
                              description: ''
                            - value: inactive
                              name: ''
                              description: ''
                        code_length:
                          type: integer
                          maximum: 32
                          minimum: 3
                        member_frequency:
                          type: integer
                          minimum: 100
                          multipleOf: 100
                        webpage_url:
                          type: string
                          x-apidog-mock: '{{$internet.url}}'
                        codes:
                          type: array
                          items:
                            type: string
                            pattern: ^[0-9]+
                      required:
                        - id
                        - name
                        - starts_at
                        - ends_at
                        - status
                        - code_length
                        - member_frequency
                        - webpage_url
                        - codes
                      $ref: '#/components/schemas/CodebreakerGame'
                  pagination_info:
                    $ref: '#/components/schemas/PaginationInfo'
                required:
                  - campaigns
                  - pagination_info
                x-apidog-orders:
                  - campaigns
                  - pagination_info
                x-apidog-ignore-properties: []
              example:
                campaigns:
                  - id: 40
                    name: Ramiro Barton
                    starts_at: '2025-10-03T13:00:00.721Z'
                    ends_at: '2025-10-03T17:00:00.721Z'
                    status: draft
                    code_length: 6
                    member_frequency: 55231200
                    webpage_url: https://male-nephew.com
                    codes:
                      - '1867'
                      - '13930703'
                      - '41802289783'
                    thumbnail:
                      identifier: '1'
                      created_at: '2022-11-09T15:46:00.252860Z'
                      image_details: null
                  - id: 37
                    name: Clint Shanahan
                    starts_at: '2025-10-03T10:00:00.721Z'
                    ends_at: '2025-10-03T22:00:00.721Z'
                    status: inactive
                    code_length: 9
                    member_frequency: 780600
                    webpage_url: https://hard-to-find-colon.us/
                    codes:
                      - '8391601751'
                      - '7192899'
                pagination_info:
                  total_count: 2050
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: API Reference/Management API/Games/Codebreaker
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3940083-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: ''
    CodebreakerGame:
      x-apidog-refs: {}
      x-apidog-orders:
        - id
        - name
        - starts_at
        - ends_at
        - status
        - code_length
        - member_frequency
        - webpage_url
        - codes
        - thumbnail
      properties:
        id:
          type: integer
        name:
          type: string
        starts_at: &ref_0
          x-apidog-mock: '{{$date.timestamp|formatISO}}'
          $ref: '#/components/schemas/date_time'
        ends_at: *ref_0
        status:
          type: string
          enum:
            - draft
            - active
            - inactive
          x-apidog-enum:
            - value: draft
              name: ''
              description: ''
            - value: active
              name: ''
              description: ''
            - value: inactive
              name: ''
              description: ''
        code_length:
          type: integer
          maximum: 32
          minimum: 3
        member_frequency:
          type: integer
          minimum: 100
          multipleOf: 100
        webpage_url:
          type: string
          x-apidog-mock: '{{$internet.url}}'
        codes:
          type: array
          items:
            type: string
            pattern: ^[0-9]+
        thumbnail:
          $ref: '#/components/schemas/File'
      required:
        - id
        - name
        - starts_at
        - ends_at
        - status
        - code_length
        - member_frequency
        - webpage_url
        - codes
        - thumbnail
      type: object
      x-apidog-ignore-properties: []
      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: ''
    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: []

```