PostHog code API

The code API from PostHog — 2 operation(s) for code.

OpenAPI Specification

posthog-code-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: PostHog actions code API
  version: 1.0.0
  description: ''
tags:
- name: code
paths:
  /api/code/invites/check-access/:
    get:
      operationId: code_invites_check_access_retrieve
      description: Check whether the authenticated user has access to PostHog Code.
      summary: Check access
      tags:
      - code
      responses:
        '200':
          description: Access check result
      x-explicit-tags:
      - code-invites
      - tasks
  /api/code/invites/redeem/:
    post:
      operationId: code_invites_redeem_create
      description: Redeem a PostHog Code invite code to enable access.
      summary: Redeem invite code
      tags:
      - code
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CodeInviteRedeemRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CodeInviteRedeemRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CodeInviteRedeemRequest'
        required: true
      responses:
        '200':
          description: Invite code redeemed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid or expired invite code
      x-explicit-tags:
      - code-invites
      - tasks
components:
  schemas:
    CodeInviteRedeemRequest:
      type: object
      properties:
        code:
          type: string
          maxLength: 50
      required:
      - code
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
      - error
  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