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

# List Annotations

> List all annotations (ratings and comments) for a specific Record.



## OpenAPI

````yaml get /records/{recordId}/annotations
openapi: 3.1.0
info:
  title: Scorecard API
  description: REST API for Scorecard
  version: 1.0.0
servers:
  - url: https://api2.scorecard.io/api/v2
security:
  - ApiKeyAuth: []
paths:
  /records/{recordId}/annotations:
    get:
      summary: List Annotations
      description: List all annotations (ratings and comments) for a specific Record.
      operationId: listAnnotations
      parameters:
        - in: path
          name: recordId
          description: The ID of the Record to list annotations for.
          schema:
            type: string
            example: '777'
          required: true
      responses:
        '200':
          description: Successfully retrieved list of Annotations for the Record.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Annotation'
                required:
                  - data
              examples:
                Annotations for a record:
                  value:
                    data:
                      - id: '1'
                        recordId: '777'
                        spanId: null
                        rating: true
                        comment: Great response!
                        userId: user_abc123
                        createdAt: '2026-03-01T12:00:00.000Z'
                      - id: '2'
                        recordId: '777'
                        spanId: span_xyz
                        rating: false
                        comment: This answer was incorrect for the given context.
                        userId: user_def456
                        createdAt: '2026-03-02T15:30:00.000Z'
                  summary: Annotations for a record
                  description: >-
                    Example response showing annotations with ratings and
                    comments on a Record.
        '401':
          $ref: '#/components/responses/UnauthenticatedError'
        '500':
          $ref: '#/components/responses/ServiceError'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Scorecard from 'scorecard-ai';

            const client = new Scorecard({
              apiKey: 'My API Key',
            });

            const annotations = await client.records.annotations.list('777');

            console.log(annotations.data);
        - lang: Python
          source: |-
            from scorecard_ai import Scorecard

            client = Scorecard(
                api_key="My API Key",
            )
            annotations = client.records.annotations.list(
                "777",
            )
            print(annotations.data)
        - lang: cURL
          source: >-
            curl https://api2.scorecard.io/api/v2/records/$RECORD_ID/annotations
            \
                -H "Authorization: Bearer $SCORECARD_API_KEY"
components:
  schemas:
    Annotation:
      type: object
      properties:
        id:
          type: string
          description: The ID of the Annotation.
        recordId:
          type: string
          description: The ID of the Record this Annotation belongs to.
        spanId:
          type:
            - string
            - 'null'
          description: Optional span ID linking this annotation to a specific span.
        rating:
          type:
            - boolean
            - 'null'
          description: >-
            The rating of the annotation: true (positive), false (negative), or
            null (no rating).
        comment:
          type:
            - string
            - 'null'
          description: An optional text comment for the annotation.
        userId:
          type: string
          description: The ID of the user who created the annotation.
        createdAt:
          type: string
          description: The ISO 8601 timestamp when the annotation was created.
      required:
        - id
        - recordId
        - spanId
        - rating
        - comment
        - userId
        - createdAt
      description: >-
        An annotation on a Record, containing a rating (thumbs up/down) and/or a
        text comment.
    ApiError:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
          x-stainless-any: true
      required:
        - code
        - message
        - details
      description: An API error.
  responses:
    UnauthenticatedError:
      description: Error indicating that the request is not authenticated.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            Authentication failure:
              value:
                code: UNAUTHORIZED
                message: Invalid or missing authentication token
                details: {}
              summary: Authentication failure
              description: >-
                Error returned when authentication credentials are invalid or
                missing.
    ServiceError:
      description: >-
        An internal service error indicating an issue with the Scorecard
        service.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          examples:
            Internal error:
              value:
                code: INTERNAL_ERROR
                message: An unexpected error occurred while processing your request.
                details: {}
              summary: Internal error
              description: Generic error when an unexpected internal issue occurs.
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: starts with ak_

````