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

# Self-scope gamification card — the caller's own points, badges and anonymised rank

> Any authenticated agent fetches THEIR OWN gamification slice (points, badges, rank, totalAgents) for the requested window. Reviewer-scope roles (owner/admin/supervisor/superAdmin) may pass an explicit `agent_id`; a non-reviewer requesting another agent returns 403. The board is computed with the DEFAULT ruleset so the agent's rank always agrees with the supervisor leaderboard, and only the caller's own slice is returned (no other agent identity is leaked).



## OpenAPI

````yaml /openapi.yaml get /api/v1/quality/gamification/me
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/quality/gamification/me:
    get:
      tags:
        - Quality
        - Gamification
      summary: >-
        Self-scope gamification card — the caller's own points, badges and
        anonymised rank
      description: >-
        Any authenticated agent fetches THEIR OWN gamification slice (points,
        badges, rank, totalAgents) for the requested window. Reviewer-scope
        roles (owner/admin/supervisor/superAdmin) may pass an explicit
        `agent_id`; a non-reviewer requesting another agent returns 403. The
        board is computed with the DEFAULT ruleset so the agent's rank always
        agrees with the supervisor leaderboard, and only the caller's own slice
        is returned (no other agent identity is leaked).
      parameters:
        - schema:
            type: string
            enum:
              - day
              - week
              - month
            default: week
          in: query
          name: period
          required: false
        - schema:
            type: string
          in: query
          name: agent_id
          required: false
      responses:
        '200':
          description: Default Response
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````