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

# List annotations

> Returns the workspace's annotations, most recent moment first. Every filter is optional; with none the most recent 100 rows come back.

Gated by the web_analytics read permission, like the rest of the web analytics surface.




## OpenAPI

````yaml /openapi.json get /api/annotations.list
openapi: 3.0.3
info:
  title: Notifuse API
  description: API for Notifuse - a transactional email and newsletter management platform
  version: 1.0.0
  contact:
    name: Notifuse Support
    url: https://www.notifuse.com/support
    email: hello@notifuse.com
servers:
  - url: https://{notifuseDomain}
    description: Customer-specific Notifuse API server
    variables:
      notifuseDomain:
        description: Your unique Notifuse domain
        default: demo.notifuse.com
security: []
paths:
  /api/annotations.list:
    get:
      tags:
        - Web Analytics
      summary: List annotations
      description: >
        Returns the workspace's annotations, most recent moment first. Every
        filter is optional; with none the most recent 100 rows come back.


        Gated by the web_analytics read permission, like the rest of the web
        analytics surface.
      operationId: listAnnotations
      parameters:
        - name: workspace_id
          in: query
          required: true
          schema:
            type: string
          description: The ID of the workspace
          example: ws_1234567890
        - name: start
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Only annotations at or after this instant. Must be RFC3339; a
            malformed value is a 400 rather than a dropped filter.
          example: '2026-08-01T00:00:00Z'
        - name: end
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Only annotations at or before this instant. Must be RFC3339.
          example: '2026-08-31T23:59:59Z'
        - name: sources
          in: query
          required: false
          schema:
            type: string
          description: >-
            Comma-separated list of sources to keep. Any value outside
            `manual`/`broadcast` is a 400.
          example: manual,broadcast
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            maximum: 1000
          description: >-
            Maximum rows to return. Values above the maximum are clamped to it
            rather than refused.
          example: 100
      responses:
        '200':
          description: Annotations matching the filters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAnnotationsResponse'
        '400':
          description: Bad request - invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingWorkspaceId:
                  value:
                    error: workspace_id is required
                malformedStart:
                  value:
                    error: start must be an RFC3339 timestamp
                endBeforeStart:
                  value:
                    error: 'invalid request: end must not be before start'
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - missing required permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: >-
                  Insufficient permissions: read access to web analytics
                  required
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Failed to list annotations
      security:
        - BearerAuth: []
components:
  schemas:
    ListAnnotationsResponse:
      type: object
      properties:
        annotations:
          type: array
          items:
            $ref: '#/components/schemas/Annotation'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
        - error
    Annotation:
      type: object
      required:
        - id
        - annotated_at
        - timezone
        - title
        - color
        - source
        - created_at
        - updated_at
      properties:
        id:
          type: string
          description: Server-generated identifier (a UUID with its dashes removed).
          example: 3f2504e04f8911d39a0c0305e82c3301
        annotated_at:
          type: string
          format: date-time
          description: The moment the annotation marks, as a real instant.
          example: '2026-08-15T09:00:00Z'
        timezone:
          type: string
          description: >-
            IANA timezone the moment was entered in. This is display intent only
            — annotated_at already fixes the instant, and filtering never uses
            this field. It is what lets "9am in Tokyo" render back as 9am
            instead of the reader's local equivalent.
          example: Asia/Tokyo
        title:
          type: string
          maxLength: 100
          description: Counted in characters, not bytes.
          example: Pricing page redesign
        description:
          type: string
          maxLength: 500
          description: Optional longer note. Counted in characters, not bytes.
          example: Rolled out to all visitors after the A/B test.
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          description: Six-digit hex colour used for the marker on the charts.
          example: '#3b82f6'
        source:
          type: string
          enum:
            - manual
            - broadcast
          description: >-
            Who wrote the row. `manual` is anything typed by an operator or
            posted to this API; `broadcast` rows are written automatically when
            a broadcast starts sending. There is deliberately no API source —
            see the note on annotations.create.
          example: manual
        source_id:
          type: string
          description: >-
            The entity that caused an automatic annotation (a broadcast id
            today). Always absent on manual rows, and never settable through the
            API. An annotation outlives the entity it points at: deleting a
            broadcast leaves its annotation, because the send did happen.
          example: bcast_1234567890
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication

````