> ## 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 User Progress



## OpenAPI

````yaml /openapi.yaml get /user/progress
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:
  /user/progress:
    get:
      tags:
        - User
      summary: Get User Progress
      parameters:
        - in: query
          name: account
          description: Account identifier of the user
          required: true
          schema:
            type: string
        - in: query
          name: platform
          description: Platform where the account exists
          required: true
          schema:
            type: string
        - in: query
          name: pid
          description: Campaign ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: >-
            User's comprehensive progress including all campaign activities and
            completion status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Campaign entry ID
                      user_id:
                        type: string
                        description: >-
                          User account identifier (same as request account
                          parameter)
                      name:
                        type: string
                        description: User's display name in the campaign
                      actions:
                        type: array
                        description: All campaign tasks with user's completion status
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Task ID
                            name:
                              type: string
                              description: Task name
                            xp:
                              type: number
                              description: Base XP reward for completing this task
                            xp_mul:
                              type: number
                              description: XP multiplier applied to this task
                            meta:
                              type: object
                              description: Additional task metadata and configuration
                              nullable: true
                            status:
                              type: string
                              enum:
                                - none
                                - completed
                              description: User's completion status for this task
                          required:
                            - id
                            - name
                            - xp
                            - xp_mul
                            - status
                      quests:
                        type: array
                        description: All campaign quests with user's completion status
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Quest ID
                            name:
                              type: string
                              description: Quest name
                            actions:
                              type: array
                              items:
                                type: string
                              description: >-
                                Array of Task IDs required to complete this
                                quest
                            xp:
                              type: number
                              description: Base XP reward for completing this quest
                            xp_mul:
                              type: number
                              description: XP multiplier applied to this quest
                            meta:
                              type: object
                              description: Additional quest metadata and configuration
                              nullable: true
                            status:
                              type: string
                              enum:
                                - none
                                - completed
                              description: User's completion status for this quest
                          required:
                            - id
                            - name
                            - actions
                            - xp
                            - xp_mul
                            - status
                      challenges:
                        type: array
                        description: All campaign challenges with user's completion status
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Challenge ID
                            name:
                              type: string
                              description: Challenge name
                            xp:
                              type: number
                              description: Base XP reward for completing this challenge
                            xp_mul:
                              type: number
                              description: XP multiplier applied to this challenge
                            meta:
                              type: object
                              description: Additional challenge metadata and configuration
                              nullable: true
                            status:
                              type: string
                              enum:
                                - none
                                - completed
                              description: User's completion status for this challenge
                          required:
                            - id
                            - name
                            - xp
                            - xp_mul
                            - status
                      rewards:
                        type: array
                        description: User's earned rewards
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Reward ID
                            reward:
                              type: string
                              description: Reward identifier or value
                            type:
                              type: string
                              description: Type of reward
                          required:
                            - id
                            - reward
                            - type
                      total:
                        type: number
                        description: >-
                          Total calculated XP from all sources (computed using
                          get_total_xp function)
                      xp:
                        type: number
                        description: Base XP earned from tasks and activities
                      ref_xp:
                        type: number
                        description: XP earned through referrals
                      ugc_xp:
                        type: number
                        description: XP earned from user-generated content
                      xp_mul:
                        type: number
                        description: User's XP multiplier
                      rank:
                        type: number
                        description: User's rank in the campaign
                      team:
                        type: string
                        description: User's team assignment (empty string if no team)
                    required:
                      - id
                      - user_id
                      - name
                      - actions
                      - quests
                      - challenges
                      - rewards
                      - total
                      - xp
                      - ref_xp
                      - ugc_xp
                      - xp_mul
                      - rank
                      - team
                required:
                  - success
                  - data
        '400':
          $ref: '#/components/responses/bad_request'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/access_denied'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
        - bearer: []
components:
  responses:
    bad_request:
      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
    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

````