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

# Get the authenticated user and granted scopes



## OpenAPI

````yaml /openapi.yaml get /api/platform/v1/me
openapi: 3.1.0
info:
  title: PunchPlay API
  version: 1.0.0-beta.3
  description: >-
    Complete beta contract for native and third-party clients, plus the stable
    read-only public profile API. OAuth access tokens use explicit per-operation
    scopes.
  summary: Platform and public API surface for PunchPlay developers.
servers:
  - url: https://punchplay.tv
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Authentication
  - name: Profile
  - name: Titles
  - name: History
  - name: Ratings
  - name: Lists
  - name: Collection
  - name: Playback
  - name: Calendar
  - name: Community
  - name: Notifications
  - name: Trophies
  - name: Public Catalog
  - name: Public Users
paths:
  /api/platform/v1/me:
    get:
      tags:
        - Profile
      summary: Get the authenticated user and granted scopes
      operationId: getMe
      responses:
        '200':
          $ref: '#/components/responses/MeSuccess'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/ApiError'
      security:
        - oauth2:
            - profile:read
components:
  responses:
    MeSuccess:
      description: Authenticated user and granted scopes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MeResponse'
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Ceiling of the most constraining bucket for this request.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time in seconds when the current window resets.
    ApiError:
      description: API error
      headers:
        X-PunchPlay-Request-Id:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Ceiling of the most constraining bucket for this request.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time in seconds when the current window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    MeResponse:
      type: object
      required:
        - id
        - username
        - name
        - profile
        - email
        - client_type
        - token_id
        - developer_app
        - scopes
      properties:
        id:
          type: string
        username:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        profile:
          type: object
          required:
            - avatarUrl
            - displayName
            - memberSince
            - xp
            - stats
          properties:
            avatarUrl:
              type:
                - string
                - 'null'
            displayName:
              type:
                - string
                - 'null'
            memberSince:
              type: string
              format: date-time
            xp:
              type: integer
              minimum: 0
            stats:
              oneOf:
                - type: object
                  required:
                    - titlesWatched
                    - episodesWatched
                    - minutesWatched
                  properties:
                    titlesWatched:
                      type: integer
                      minimum: 0
                    episodesWatched:
                      type: integer
                      minimum: 0
                    minutesWatched:
                      type: integer
                      minimum: 0
                  additionalProperties: false
                - type: 'null'
          additionalProperties: false
        email:
          type:
            - string
            - 'null'
          format: email
        client_type:
          type: string
        token_id:
          type: string
        developer_app:
          oneOf:
            - type: object
              required:
                - id
                - name
              properties:
                id:
                  type: string
                name:
                  type:
                    - string
                    - 'null'
              additionalProperties: false
            - type: 'null'
        scopes:
          type: array
          items:
            type: string
          uniqueItems: true
      additionalProperties: false
    ApiError:
      type: object
      required:
        - error
        - message
        - request_id
      properties:
        error:
          type: string
        message:
          type: string
        request_id:
          type:
            - string
            - 'null'
        required_scope:
          type: string
      additionalProperties: true
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /api/platform/v1/oauth/authorize
          tokenUrl: /api/platform/v1/oauth/token
          scopes:
            profile:read: Read basic profile and title metadata
            history:read: Read watch history
            history:write: Log, edit, and delete watches
            lists:read: Read lists
            lists:write: Create and edit lists
            ratings:read: Read ratings, favourites, and statuses
            ratings:write: Rate, favourite, and change statuses
            collection:read: Read collection items
            collection:write: Add and remove collection items
            notifications:read: Read notifications and notification preferences
            notifications:write: Manage notification read state and preferences
            trophies:read: Read trophy progress
            profile:write: Update profile details and preferences
            playback:read: Read playback and continue-watching state
            playback:write: Update playback state
            events:read: Subscribe to playback events

````