PostHog groups API

openapi: 3.0.3
info:
  title: PostHog actions groups API
  version: 1.0.0
  description: ''
tags:
- name: groups
paths:
  /api/environments/{environment_id}/groups/:
    get:
      operationId: environments_groups_list
      description: List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to list
        required: true
      - in: query
        name: search
        schema:
          type: string
        description: Search the group name
        required: true
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    post:
      operationId: environments_groups_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateGroup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateGroup'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - group:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/activity/:
    get:
      operationId: environments_groups_activity_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - in: query
        name: id
        schema:
          type: string
        description: Specify the id of the user to find groups for
        required: true
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - activity_log:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/delete_property/:
    post:
      operationId: environments_groups_delete_property_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: group_key
        schema:
          type: string
        description: Specify the key of the group to find
        required: true
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Group'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Group'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - group:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/find/:
    get:
      operationId: environments_groups_find_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: group_key
        schema:
          type: string
        description: Specify the key of the group to find
        required: true
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/property_definitions/:
    get:
      operationId: environments_groups_property_definitions_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/property_values/:
    get:
      operationId: environments_groups_property_values_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/related/:
    get:
      operationId: environments_groups_related_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - in: query
        name: id
        schema:
          type: string
        description: Specify the id of the user to find groups for
        required: true
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/groups/update_property/:
    post:
      operationId: environments_groups_update_property_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: group_key
        schema:
          type: string
        description: Specify the key of the group to find
        required: true
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Group'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Group'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - group:write
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/:
    get:
      operationId: groups_list
      description: List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
      parameters:
      - name: cursor
        required: false
        in: query
        description: The pagination cursor value.
        schema:
          type: string
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to list
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      - in: query
        name: search
        schema:
          type: string
        description: Search the group name
        required: true
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupList'
          description: ''
      x-explicit-tags:
      - core
    post:
      operationId: groups_create
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateGroup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateGroup'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - group:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/activity/:
    get:
      operationId: groups_activity_retrieve
      parameters:
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - in: query
        name: id
        schema:
          type: string
        description: Specify the id of the user to find groups for
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - activity_log:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/delete_property/:
    post:
      operationId: groups_delete_property_create
      parameters:
      - in: query
        name: group_key
        schema:
          type: string
        description: Specify the key of the group to find
        required: true
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Group'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Group'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - group:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/find/:
    get:
      operationId: groups_find_retrieve
      parameters:
      - in: query
        name: group_key
        schema:
          type: string
        description: Specify the key of the group to find
        required: true
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/property_definitions/:
    get:
      operationId: groups_property_definitions_retrieve
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/property_values/:
    get:
      operationId: groups_property_values_retrieve
      parameters:
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/related/:
    get:
      operationId: groups_related_retrieve
      parameters:
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - in: query
        name: id
        schema:
          type: string
        description: Specify the id of the user to find groups for
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      security:
      - PersonalAPIKeyAuth:
        - group:read
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
  /api/projects/{project_id}/groups/update_property/:
    post:
      operationId: groups_update_property_create
      parameters:
      - in: query
        name: group_key
        schema:
          type: string
        description: Specify the key of the group to find
        required: true
      - in: query
        name: group_type_index
        schema:
          type: integer
        description: Specify the group type to find
        required: true
      - $ref: '#/components/parameters/ProjectIdPath'
      tags:
      - groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Group'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Group'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - group:write
      responses:
        '200':
          description: No response body
      x-explicit-tags:
      - core
components:
  schemas:
    Group:
      type: object
      properties:
        group_type_index:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        group_key:
          type: string
          maxLength: 400
        group_properties: {}
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - created_at
      - group_key
      - group_type_index
    CreateGroup:
      type: object
      properties:
        group_type_index:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        group_key:
          type: string
          maxLength: 400
        group_properties:
          nullable: true
      required:
      - group_key
      - group_type_index
    PaginatedGroupList:
      type: object
      required:
      - results
      properties:
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?cursor=cD00ODY%3D"
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
        results:
          type: array
          items:
            $ref: '#/components/schemas/Group'
  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/.
    EnvironmentIdPath:
      in: path
      name: environment_id
      required: true
      schema:
        type: string
      description: Deprecated. Use /api/projects/{project_id}/ instead.
  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