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

# The week's board

> Who opted in, ranked on verified focus time and consistency — never on how many tasks they ticked — under a named, versioned rule. Global, or only the people you follow and you. This week, or last week's recap.



## OpenAPI

````yaml https://api.doers.sh/openapi.json get /v2/leaderboard
openapi: 3.1.0
info:
  title: Doers API
  version: 2.0.0
  description: >-
    The open API of Doers: tasks, projects, areas, prioritised context and the
    day's plan.


    ## Authentication


    Every route requires a bearer token, generated from **Settings > API & MCP**
    in the app:


    ```

    Authorization: Bearer pc_…

    ```


    ## Two date fields, not to be confused


    - `when` — the **schedule**: `today`, `anytime` (Later), `someday` (Future)
    or a date.

    - `deadline` — the **commitment**, independent of the schedule.


    ## Time zone


    The server reasons in UTC and does not know yours. Send the `X-PC-Today:
    YYYY-MM-DD` header

    (or the `day` argument where it exists) so dated operations use your local
    day.


    ## MCP server


    The same token gives access to the [Model Context
    Protocol](https://modelcontextprotocol.io)

    server at `POST https://doers.sh/mcp`, which exposes the same operations as
    tools for Claude,

    Cursor and other compatible clients.
servers:
  - url: https://api.doers.sh
    description: Production.
security:
  - bearerAuth: []
tags:
  - name: Tasks
  - name: Projects
  - name: Areas
  - name: Headings
  - name: Comments
  - name: Realtime
  - name: Devices
  - name: Context
  - name: Plan
  - name: Sessions
  - name: Rounds
  - name: Journal
  - name: Habits
  - name: Stats
  - name: Users
  - name: Profiles
  - name: Workspaces
  - name: Access
  - name: Activity
  - name: Tokens
  - name: Referrals
  - name: Files
  - name: Connections
  - name: Collaborators
  - name: Links
  - name: Packages
  - name: Installs
  - name: Billing
  - name: Calendar
  - name: Coach
  - name: Marketplace
paths:
  /v2/leaderboard:
    get:
      tags:
        - Profiles
      summary: The week's board
      description: >-
        Who opted in, ranked on verified focus time and consistency — never on
        how many tasks they ticked — under a named, versioned rule. Global, or
        only the people you follow and you. This week, or last week's recap.
      operationId: getLeaderboard
      parameters:
        - name: scope
          in: query
          required: true
          schema:
            type: string
            enum:
              - global
              - following
        - name: week
          in: query
          required: true
          description: This week, or last week's recap. Weeks start on Monday, UTC.
          schema:
            type: string
            enum:
              - current
              - previous
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  leaderboard:
                    type: object
                    properties:
                      version:
                        type: string
                        description: The ranking rule this board was ranked under.
                      scope:
                        type: string
                        enum:
                          - global
                          - following
                      week:
                        type: string
                        enum:
                          - current
                          - previous
                        description: >-
                          This week, or last week's recap. Weeks start on
                          Monday, UTC.
                      weekStart:
                        type: string
                        format: date
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
                        description: Local day key, `YYYY-MM-DD`.
                      entries:
                        type: array
                        items:
                          type: object
                          properties:
                            rank:
                              type: integer
                              minimum: 1
                              maximum: 9007199254740991
                              description: >-
                                Competition ranking: equal activity shares a
                                rank.
                            username:
                              type: string
                            name:
                              type: string
                            image:
                              anyOf:
                                - type: string
                                - type: 'null'
                            focusMinutes:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            activeDays:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            streakDays:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                              description: The longest run of active days in the week.
                            isMe:
                              type: boolean
                          required:
                            - rank
                            - username
                            - name
                            - image
                            - focusMinutes
                            - activeDays
                            - streakDays
                            - isMe
                          additionalProperties: false
                      me:
                        anyOf:
                          - type: object
                            properties:
                              rank:
                                type: integer
                                minimum: 1
                                maximum: 9007199254740991
                                description: >-
                                  Competition ranking: equal activity shares a
                                  rank.
                              username:
                                type: string
                              name:
                                type: string
                              image:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              focusMinutes:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              activeDays:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              streakDays:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                                description: The longest run of active days in the week.
                              isMe:
                                type: boolean
                            required:
                              - rank
                              - username
                              - name
                              - image
                              - focusMinutes
                              - activeDays
                              - streakDays
                              - isMe
                            additionalProperties: false
                          - type: 'null'
                        description: '`null` unless you opted in.'
                    required:
                      - version
                      - scope
                      - week
                      - weekStart
                      - entries
                      - me
                    additionalProperties: false
                required:
                  - leaderboard
                additionalProperties: false
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: >-
        Invalid request — unreadable body, out-of-range field or unknown
        parameter.
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Token missing, unknown or revoked.
    TooManyRequests:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Too many requests. `Retry-After` says how many seconds to wait.
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable machine-readable code.
            message:
              type: string
              description: Human-readable message.
            details:
              type: array
              description: Per-field detail, present on validation errors.
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - field
                  - message
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `pc_…` token generated from Settings > API & MCP.

````