> ## 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 Points

> Retrieves campaign statistics including total points earned, current season points, season index, and current season details. Calculates season progression based on configured season thresholds.



## OpenAPI

````yaml /openapi.yaml get /campaign/points
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/points:
    get:
      tags:
        - Campaign
      summary: Get Campaign Points
      description: >-
        Retrieves campaign statistics including total points earned, current
        season points, season index, and current season details. Calculates
        season progression based on configured season thresholds.
      parameters:
        - in: query
          name: pid
          description: Campaign ID to retrieve points information for
          required: true
          schema:
            type: string
          example: campaign_abc123
      responses:
        '200':
          description: Campaign points and season 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
                      total_points:
                        type: number
                        description: Total points earned across all seasons
                        example: 2500
                      season_points:
                        type: number
                        description: Points earned in the current season
                        example: 350
                      season_index:
                        type: number
                        description: Current season index (0-based)
                        example: 2
                      season:
                        type: object
                        nullable: true
                        description: >-
                          Current season information, null if no seasons
                          configured or all seasons completed
                        properties:
                          name:
                            type: string
                            description: Current season name
                            example: 'Season 3: Masters'
                          max_xp:
                            type: number
                            description: Maximum XP required to complete this season
                            example: 1000
        '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
        '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

````