> ## Documentation Index
> Fetch the complete documentation index at: https://docs.claimr.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Campaign Info

> Retrieves comprehensive campaign data including all tasks, quests, their properties, dependencies, and reward structures. Supports both published and development environments.



## OpenAPI

````yaml /openapi.yaml get /campaign/info
openapi: 3.0.0
info:
  title: claimr API
  version: 1.0.0
  description: >-
    Advanced features of claimr for business partners. This API provides a
    seamless integration with claimr services
  termsOfService: https://claimr.io/terms-of-service/
  contact:
    name: claimr support team
    email: support@claimr.io
servers:
  - url: https://prod.claimr.io/api/v1
    description: Production server
  - url: https://prod.claimr.io/api/v1
    description: Development server
security: []
tags: []
paths:
  /campaign/info:
    get:
      tags:
        - Campaign
      summary: Get Campaign Info
      description: >-
        Retrieves comprehensive campaign data including all tasks, quests, their
        properties, dependencies, and reward structures. Supports both published
        and development environments.
      parameters:
        - in: query
          name: pid
          description: Campaign ID to retrieve information for
          required: true
          schema:
            type: string
          example: campaign_abc123
      responses:
        '200':
          description: Campaign information retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Campaign ID
                        example: campaign_abc123
                      name:
                        type: string
                        description: Campaign display name
                        example: Summer Gaming Challenge
                      actions:
                        type: array
                        description: List of all tasks available in the campaign
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique task identifier
                              example: daily_login
                            name:
                              type: string
                              description: Task display name
                              example: Daily Login
                            type:
                              type: string
                              description: Task type identifier
                              example: api_call
                            recurrence:
                              type: string
                              description: How often the task can be performed
                              example: daily
                            ref_xp:
                              type: string
                              description: XP reward for referrals related to this task
                              example: '10'
                            xp:
                              type: number
                              description: Base XP reward for completing this task
                              example: 50
                            xp_mul:
                              type: string
                              description: XP multiplier applied to base reward
                              example: '1.5'
                            meta:
                              type: object
                              description: Additional metadata for the task
                              additionalProperties: true
                            deps:
                              type: array
                              description: >-
                                List of task IDs that must be completed before
                                this task
                              items:
                                type: string
                                description: Dependent task ID
                              example:
                                - tutorial_completed
                            is_optional:
                              type: boolean
                              description: >-
                                Whether this task is optional for campaign
                                completion
                              example: false
                      quests:
                        type: array
                        description: List of quests in the campaign
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Unique quest identifier
                              example: weekly_challenge
                            name:
                              type: string
                              description: Quest display name
                              example: Weekly Challenge
                            actions:
                              type: array
                              description: List of task IDs required to complete this quest
                              items:
                                type: string
                                description: Task ID
                              example:
                                - daily_login
                                - complete_match
                            xp:
                              type: number
                              description: XP reward for completing this quest
                              example: 200
                            xp_mul:
                              type: string
                              description: XP multiplier applied to quest reward
                              example: '2.0'
                            meta:
                              type: object
                              description: Additional metadata for the quest
                              additionalProperties: true
                            deps:
                              type: array
                              description: >-
                                List of quest IDs that must be completed before
                                this quest
                              items:
                                type: string
                                description: Dependent quest ID
                              example:
                                - beginner_quest
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                        default: 400
                      message:
                        type: string
                        default: bad request
              examples:
                missing_pid:
                  summary: Missing campaign ID
                  value:
                    error: Campaign ID (pid) is required
                campaign_not_found:
                  summary: Campaign not found
                  value:
                    error: >-
                      Campaign bundle not found for the specified ID and
                      environment
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/access_denied'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
        - bearer: []
components:
  responses:
    unauthorized:
      description: Unauthorized request
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 401
                  message:
                    type: string
                    default: unauthorized
    access_denied:
      description: Access denied
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 403
                  message:
                    type: string
                    default: access denied
    internal_error:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 500
                  message:
                    type: string
                    default: internal error
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````