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

# Get your roadmap comment viewer state

> Whether you wrote the comment, and how you reacted to it.



## OpenAPI

````yaml /openapi/backend.json get /v1/roadmapBoards/{board}/items/{item}/comments/{comment}/viewerState
openapi: 3.0.0
info:
  title: Plazza API
  description: >-
    The Plazza REST API. Errors follow AIP-193 and carry a message in the
    language of Accept-Language, French or English.
  version: v1
servers:
  - url: https://api.plazza.ca
security:
  - bearer: []
paths:
  /v1/roadmapBoards/{board}/items/{item}/comments/{comment}/viewerState:
    get:
      tags:
        - Roadmap
      summary: Get your roadmap comment viewer state
      description: Whether you wrote the comment, and how you reacted to it.
      operationId: RoadmapParticipation.getCommentViewerState
      parameters:
        - name: board
          required: true
          in: path
          description: 'The board: `hire` for employers, `talents` for job seekers.'
          schema:
            type: string
            enum:
              - hire
              - talents
            description: 'The board: `hire` for employers, `talents` for job seekers.'
            example: hire
        - name: item
          required: true
          in: path
          description: The item's id.
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            description: The item's id.
            example: 019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e
        - name: comment
          required: true
          in: path
          description: The comment's id.
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            description: The comment's id.
            example: 019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d
      responses:
        '200':
          description: >-
            What you did on one comment: private to you. A singleton under the
            comment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoadmapCommentViewerState'
        default:
          description: An AIP-193 error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    RoadmapCommentViewerState:
      type: object
      properties:
        name:
          type: string
          description: The viewer state's resource name, under its comment.
          example: >-
            roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e/comments/019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d/viewerState
        owned:
          type: boolean
          description: Whether you wrote the comment.
          example: false
        reactions:
          type: array
          items:
            type: string
            enum:
              - 👍
              - ❤️
              - 🎉
              - 👀
            description: One of the four reactions.
            example: 👍
          description: The reactions you gave the comment, oldest first.
          example:
            - 👍
      required:
        - name
        - owned
        - reactions
      additionalProperties: false
      description: >-
        What you did on one comment: private to you. A singleton under the
        comment.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            message:
              type: string
            status:
              type: string
              enum:
                - INVALID_ARGUMENT
                - FAILED_PRECONDITION
                - OUT_OF_RANGE
                - UNAUTHENTICATED
                - PERMISSION_DENIED
                - NOT_FOUND
                - ABORTED
                - ALREADY_EXISTS
                - RESOURCE_EXHAUSTED
                - INTERNAL
                - UNIMPLEMENTED
                - UNAVAILABLE
                - DEADLINE_EXCEEDED
            details:
              type: array
              items:
                oneOf:
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.ErrorInfo
                      reason:
                        type: string
                      domain:
                        type: string
                      metadata:
                        type: object
                        additionalProperties:
                          type: string
                    required:
                      - '@type'
                      - reason
                      - domain
                    additionalProperties: false
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.LocalizedMessage
                      locale:
                        type: string
                      message:
                        type: string
                    required:
                      - '@type'
                      - locale
                      - message
                    additionalProperties: false
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.BadRequest
                      fieldViolations:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            description:
                              type: string
                          required:
                            - field
                            - description
                          additionalProperties: false
                    required:
                      - '@type'
                      - fieldViolations
                    additionalProperties: false
                  - type: object
                    properties:
                      '@type':
                        type: string
                        enum:
                          - type.googleapis.com/google.rpc.RetryInfo
                      retryDelay:
                        type: string
                        pattern: ^\d+s$
                    required:
                      - '@type'
                      - retryDelay
                    additionalProperties: false
          required:
            - code
            - message
            - status
            - details
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: An AIP-193 error.
      example:
        error:
          code: 401
          message: Unauthorized
          status: UNAUTHENTICATED
          details:
            - '@type': type.googleapis.com/google.rpc.ErrorInfo
              reason: MISSING_CREDENTIALS
              domain: api.plazza.ca
            - '@type': type.googleapis.com/google.rpc.LocalizedMessage
              locale: en
              message: Sign in to continue.
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: >-
        The session token of a signed-in Plazza account, sent as `Authorization:
        Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.