PostHog annotations API

openapi: 3.0.3
info:
  title: PostHog actions annotations API
  version: 1.0.0
  description: ''
tags:
- name: annotations
paths:
  /api/projects/{project_id}/annotations/:
    get:
      operationId: annotations_list
      description: Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
      parameters:
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - $ref: '#/components/parameters/ProjectIdPath'
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - annotations
      security:
      - PersonalAPIKeyAuth:
        - annotation:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAnnotationList'
          description: ''
      x-explicit-tags:
      - core
    post:
      operationId: annotations_create
      description: Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - annotations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Annotation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Annotation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Annotation'
      security:
      - PersonalAPIKeyAuth:
        - annotation:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotation'
          description: ''
      x-explicit-tags:
      - core
  /api/projects/{project_id}/annotations/{id}/:
    get:
      operationId: annotations_retrieve
      description: Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this annotation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - annotations
      security:
      - PersonalAPIKeyAuth:
        - annotation:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotation'
          description: ''
      x-explicit-tags:
      - core
    put:
      operationId: annotations_update
      description: Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this annotation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - annotations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Annotation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Annotation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Annotation'
      security:
      - PersonalAPIKeyAuth:
        - annotation:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotation'
          description: ''
      x-explicit-tags:
      - core
    patch:
      operationId: annotations_partial_update
      description: Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this annotation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - annotations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAnnotation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAnnotation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAnnotation'
      security:
      - PersonalAPIKeyAuth:
        - annotation:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Annotation'
          description: ''
      x-explicit-tags:
      - core
    delete:
      operationId: annotations_destroy
      description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this annotation.
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - annotations
      security:
      - PersonalAPIKeyAuth:
        - annotation:write
      responses:
        '405':
          description: No response body
      x-explicit-tags:
      - core
components:
  schemas:
    AnnotationScopeEnum:
      enum:
      - dashboard_item
      - dashboard
      - project
      - organization
      - recording
      type: string
      description: '* `dashboard_item` - insight

        * `dashboard` - dashboard

        * `project` - project

        * `organization` - organization

        * `recording` - recording'
    BlankEnum:
      enum:
      - ''
    PatchedAnnotation:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        content:
          type: string
          nullable: true
          description: Annotation text shown on charts to describe the change, release, or incident.
          maxLength: 8192
        date_marker:
          type: string
          format: date-time
          nullable: true
          description: When this annotation happened (ISO 8601 timestamp). Used to position it on charts.
        creation_type:
          allOf:
          - $ref: '#/components/schemas/CreationTypeEnum'
          description: 'Who created this annotation. Use `USR` for user-created notes and `GIT` for bot/deployment notes.


            * `USR` - user

            * `GIT` - GitHub'
        dashboard_item:
          type: integer
          nullable: true
        dashboard_id:
          type: integer
          nullable: true
        dashboard_name:
          type: string
          nullable: true
          readOnly: true
        insight_short_id:
          type: string
          nullable: true
          readOnly: true
        insight_name:
          type: string
          nullable: true
          readOnly: true
        insight_derived_name:
          type: string
          nullable: true
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        deleted:
          type: boolean
          description: Soft-delete flag. Set to true to hide the annotation, or false to restore it.
        scope:
          allOf:
          - $ref: '#/components/schemas/AnnotationScopeEnum'
          description: 'Annotation visibility scope: `project`, `organization`, `dashboard`, or `dashboard_item`. `recording` is deprecated and rejected.


            * `dashboard_item` - insight

            * `dashboard` - dashboard

            * `project` - project

            * `organization` - organization

            * `recording` - recording'
    UserBasic:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        uuid:
          type: string
          format: uuid
          readOnly: true
        distinct_id:
          type: string
          nullable: true
          maxLength: 200
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
        email:
          type: string
          format: email
          title: Email address
          maxLength: 254
        is_email_verified:
          type: boolean
          nullable: true
        hedgehog_config:
          type: object
          additionalProperties: true
          nullable: true
          readOnly: true
        role_at_organization:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/RoleAtOrganizationEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - email
      - hedgehog_config
      - id
      - uuid
    Annotation:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        content:
          type: string
          nullable: true
          description: Annotation text shown on charts to describe the change, release, or incident.
          maxLength: 8192
        date_marker:
          type: string
          format: date-time
          nullable: true
          description: When this annotation happened (ISO 8601 timestamp). Used to position it on charts.
        creation_type:
          allOf:
          - $ref: '#/components/schemas/CreationTypeEnum'
          description: 'Who created this annotation. Use `USR` for user-created notes and `GIT` for bot/deployment notes.


            * `USR` - user

            * `GIT` - GitHub'
        dashboard_item:
          type: integer
          nullable: true
        dashboard_id:
          type: integer
          nullable: true
        dashboard_name:
          type: string
          nullable: true
          readOnly: true
        insight_short_id:
          type: string
          nullable: true
          readOnly: true
        insight_name:
          type: string
          nullable: true
          readOnly: true
        insight_derived_name:
          type: string
          nullable: true
          readOnly: true
        created_by:
          allOf:
          - $ref: '#/components/schemas/UserBasic'
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        deleted:
          type: boolean
          description: Soft-delete flag. Set to true to hide the annotation, or false to restore it.
        scope:
          allOf:
          - $ref: '#/components/schemas/AnnotationScopeEnum'
          description: 'Annotation visibility scope: `project`, `organization`, `dashboard`, or `dashboard_item`. `recording` is deprecated and rejected.


            * `dashboard_item` - insight

            * `dashboard` - dashboard

            * `project` - project

            * `organization` - organization

            * `recording` - recording'
      required:
      - created_at
      - created_by
      - dashboard_name
      - id
      - insight_derived_name
      - insight_name
      - insight_short_id
      - updated_at
    PaginatedAnnotationList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/Annotation'
    RoleAtOrganizationEnum:
      enum:
      - engineering
      - data
      - product
      - founder
      - leadership
      - marketing
      - sales
      - other
      type: string
      description: '* `engineering` - Engineering

        * `data` - Data

        * `product` - Product Management

        * `founder` - Founder

        * `leadership` - Leadership

        * `marketing` - Marketing

        * `sales` - Sales / Success

        * `other` - Other'
    CreationTypeEnum:
      enum:
      - USR
      - GIT
      type: string
      description: '* `USR` - user

        * `GIT` - GitHub'
    NullEnum:
      enum:
      - null
  parameters:
    ProjectIdPath:
      in: path
      name: project_id
      required: true
      schema:
        type: string
      description: Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
  securitySchemes:
    PersonalAPIKeyAuth:
      type: http
      scheme: bearer
x-tagGroups:
- name: All endpoints
  tags:
  - LLM Analytics
  - actions
  - activity_log
  - activity_logs
  - advanced_activity_logs
  - alerts
  - annotations
  - approval_policies
  - batch_exports
  - cdp
  - change_requests
  - code
  - code-invites
  - cohorts
  - comments
  - conversations
  - core
  - customer_analytics
  - customer_journeys
  - customer_profile_configs
  - dashboard_templates
  - dashboards
  - data_color_themes
  - data_modeling_jobs
  - data_warehouse
  - dataset_items
  - datasets
  - desktop_recordings
  - domains
  - early_access_feature
  - early_access_features
  - elements
  - endpoints
  - environments
  - error_tracking
  - evaluation_runs
  - evaluations
  - event_definitions
  - event_filter
  - event_schemas
  - events
  - experiment_holdouts
  - experiment_saved_metrics
  - experiments
  - exports
  - external_data_schemas
  - external_data_sources
  - feature_flags
  - file_system
  - file_system_shortcut
  - flag_value
  - groups
  - groups_types
  - health_issues
  - heatmap_screenshots
  - heatmaps
  - hog_flows
  - hog_function_templates
  - hog_functions
  - insight_variables
  - insights
  - integrations
  - invites
  - js-snippet
  - legal_documents
  - lineage
  - live_debugger_breakpoints
  - llm_analytics
  - llm_prompts
  - llm_skills
  - logs
  - managed_viewsets
  - max
  - max_tools
  - mcp_server_installations
  - mcp_servers
  - mcp_store
  - mcp_tools
  - members
  - notebooks
  - oauth_applications
  - object_media_previews
  - organizations
  - persisted_folder
  - persons
  - platform_features
  - plugin_configs
  - product_analytics
  - product_tours
  - project_secret_api_keys
  - projects
  - property_definitions
  - proxy_records
  - public_hog_function_templates
  - query
  - replay
  - reverse_proxy
  - role_external_references
  - roles
  - sandbox-environments
  - sandbox_environments
  - saved
  - schema_property_groups
  - sdk_doctor
  - session_group_summaries
  - session_recording_playlists
  - session_recordings
  - session_summaries
  - sessions
  - signals
  - subscriptions
  - surveys
  - taggers
  - task-automations
  - task-runs
  - task_automations
  - tasks
  - uploaded_media
  - user_home_settings
  - user_interviews
  - users
  - visual_review
  - warehouse_dag
  - warehouse_model_paths
  - warehouse_saved_queries
  - warehouse_saved_query_folders
  - warehouse_tables
  - warehouse_view_link
  - warehouse_view_links
  - web_analytics
  - web_experiments
  - web_vitals
  - welcome
  - workflows