> ## 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. # Batch get your roadmap comment viewer states > Your viewer states on up to 50 comments, in the order named, to show on a page of them. Use `-` as the comment to read across an item, and as the item too to read across the board. One name that is invalid, outside the parent or not found fails the whole request. ## OpenAPI ````yaml /openapi/backend.json get /v1/roadmapBoards/{board}/items/{item}/comments/{comment}/viewerStates:batchGet 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}/viewerStates:batchGet: get: tags: - Roadmap summary: Batch get your roadmap comment viewer states description: >- Your viewer states on up to 50 comments, in the order named, to show on a page of them. Use `-` as the comment to read across an item, and as the item too to read across the board. One name that is invalid, outside the parent or not found fails the whole request. operationId: RoadmapParticipation.batchGetCommentViewerStates 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, or `-` for any item on the board. schema: anyOf: - type: string enum: - '-' - 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, or `-` for any item on the board. example: '-' - name: comment required: true in: path description: The comment's id, or `-` for any comment on the item. schema: anyOf: - type: string enum: - '-' - 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, or `-` for any comment on the item. example: '-' - name: names required: true in: query description: >- The comment viewer states to read, 1 to 50, each under a comment of the parent. Repeat the parameter for each. schema: description: >- The comment viewer states to read, 1 to 50, each under a comment of the parent. Repeat the parameter for each. example: - >- roadmapBoards/hire/items/019a7c2e-4b1d-7c3a-9d4e-5f6a7b8c9d0e/comments/019a7c31-0e2f-7a1b-8c3d-4e5f6a7b8c9d/viewerState minItems: 1 maxItems: 50 type: array items: type: string minLength: 1 maxLength: 300 responses: '200': description: Your viewer states on the comments asked for. content: application/json: schema: $ref: >- #/components/schemas/BatchGetRoadmapCommentViewerStatesResponse default: description: An AIP-193 error. content: application/json: schema: $ref: '#/components/schemas/Error' components: schemas: BatchGetRoadmapCommentViewerStatesResponse: type: object properties: viewerStates: type: array items: $ref: '#/components/schemas/RoadmapCommentViewerState' description: The viewer states asked for, in the order of `names`. required: - viewerStates additionalProperties: false description: Your viewer states on the comments asked for. 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. 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. securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http description: >- The session token of a signed-in Plazza account, sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.