PostHog welcome API

openapi: 3.0.3
info:
  title: PostHog actions welcome API
  version: 1.0.0
  description: ''
tags:
- name: welcome
paths:
  /api/organizations/{organization_id}/welcome/current/:
    get:
      operationId: welcome_current_retrieve
      description: Aggregated payload for the invited-user welcome screen.
      parameters:
      - $ref: '#/components/parameters/OrganizationIdPath'
      tags:
      - welcome
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WelcomeResponse'
          description: ''
        '404':
          description: Current organization not found
      x-explicit-tags:
      - platform_features
components:
  schemas:
    WelcomeResponse:
      type: object
      properties:
        organization_name:
          type: string
        inviter:
          allOf:
          - $ref: '#/components/schemas/_WelcomeInviter'
          nullable: true
        team_members:
          type: array
          items:
            $ref: '#/components/schemas/_WelcomeTeamMember'
        recent_activity:
          type: array
          items:
            $ref: '#/components/schemas/_WelcomeRecentActivity'
        popular_dashboards:
          type: array
          items:
            $ref: '#/components/schemas/_WelcomePopularDashboard'
        products_in_use:
          type: array
          items:
            type: string
        suggested_next_steps:
          type: array
          items:
            $ref: '#/components/schemas/_WelcomeSuggestedStep'
        is_organization_first_user:
          type: boolean
      required:
      - inviter
      - is_organization_first_user
      - organization_name
      - popular_dashboards
      - products_in_use
      - recent_activity
      - suggested_next_steps
      - team_members
    LastActiveEnum:
      enum:
      - today
      - this_week
      - inactive
      - never
      type: string
      description: '* `today` - today

        * `this_week` - this_week

        * `inactive` - inactive

        * `never` - never'
    _WelcomePopularDashboard:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        team_id:
          type: integer
        url:
          type: string
      required:
      - description
      - id
      - name
      - team_id
      - url
    _WelcomeSuggestedStep:
      type: object
      properties:
        label:
          type: string
        href:
          type: string
        reason:
          type: string
        docs_href:
          type: string
        product_key:
          type: string
      required:
      - href
      - label
      - reason
    _WelcomeRecentActivity:
      type: object
      properties:
        type:
          type: string
          description: Scope.activity pair, e.g. 'Insight.created'.
        actor_name:
          type: string
        entity_name:
          type: string
        entity_url:
          type: string
          nullable: true
        timestamp:
          type: string
          format: date-time
      required:
      - actor_name
      - entity_name
      - entity_url
      - timestamp
      - type
    _WelcomeInviter:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
      required:
      - email
      - name
    _WelcomeTeamMember:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
          format: email
        avatar:
          type: string
          nullable: true
        role:
          type: string
        last_active:
          $ref: '#/components/schemas/LastActiveEnum'
      required:
      - avatar
      - email
      - last_active
      - name
      - role
  parameters:
    OrganizationIdPath:
      in: path
      name: organization_id
      required: true
      schema:
        type: string
      description: ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/.
  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