PostHog API — endpoints

naftiko: 1.0.0-alpha2
info:
  label: PostHog API — endpoints
  description: 'PostHog API — endpoints. 52 operations. Lead operation: endpoints. Self-contained Naftiko capability covering
    one Posthog business surface.'
  tags:
  - Posthog
  - endpoints
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POSTHOG_API_KEY: POSTHOG_API_KEY
capability:
  consumes:
  - type: http
    namespace: posthog-endpoints
    baseUri: ''
    description: PostHog API — endpoints business capability. Self-contained, no shared references.
    resources:
    - name: api-environments-environment_id-endpoints
      path: /api/environments/{environment_id}/endpoints/
      operations:
      - name: environmentsendpointslist
        method: GET
        description: List all endpoints for the team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: environmentsendpointslist
        method: GET
        description: List all endpoints for the team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: environmentsendpointscreate
        method: POST
        description: Create a new endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointscreate
        method: POST
        description: Create a new endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-endpoints-last_execution_times
      path: /api/environments/{environment_id}/endpoints/last_execution_times/
      operations:
      - name: environmentsendpointslastexecutiontimescreate
        method: POST
        description: Get the last execution times in the past 6 months for multiple endpoints.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: environmentsendpointslastexecutiontimescreate
        method: POST
        description: Get the last execution times in the past 6 months for multiple endpoints.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-endpoints-name
      path: /api/environments/{environment_id}/endpoints/{name}/
      operations:
      - name: environmentsendpointsretrieve
        method: GET
        description: Retrieve an endpoint, or a specific version via ?version=N.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: environmentsendpointsretrieve
        method: GET
        description: Retrieve an endpoint, or a specific version via ?version=N.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: environmentsendpointsupdate
        method: PUT
        description: Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param
          to target a specific version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointsupdate
        method: PUT
        description: Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param
          to target a specific version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointspartialupdate
        method: PATCH
        description: Update an existing endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointspartialupdate
        method: PATCH
        description: Update an existing endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointsdestroy
        method: DELETE
        description: Delete an endpoint and clean up materialized query.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: environmentsendpointsdestroy
        method: DELETE
        description: Delete an endpoint and clean up materialized query.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: api-environments-environment_id-endpoints-name-materialization_preview
      path: /api/environments/{environment_id}/endpoints/{name}/materialization_preview/
      operations:
      - name: environmentsendpointsmaterializationpreviewcreate
        method: POST
        description: Preview the materialization transform for an endpoint. Shows what the query will look like after materialization,
          including range pair detection and bucket functions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointsmaterializationpreviewcreate
        method: POST
        description: Preview the materialization transform for an endpoint. Shows what the query will look like after materialization,
          including range pair detection and bucket functions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-endpoints-name-materialization_status
      path: /api/environments/{environment_id}/endpoints/{name}/materialization_status/
      operations:
      - name: environmentsendpointsmaterializationstatusretrieve
        method: GET
        description: Get materialization status for an endpoint. Supports ?version=N query param.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: environmentsendpointsmaterializationstatusretrieve
        method: GET
        description: Get materialization status for an endpoint. Supports ?version=N query param.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: api-environments-environment_id-endpoints-name-openapi.json
      path: /api/environments/{environment_id}/endpoints/{name}/openapi.json/
      operations:
      - name: environmentsendpointsopenapijsonretrieve
        method: GET
        description: Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: integer
          description: Specific endpoint version to generate the spec for. Defaults to latest.
      - name: environmentsendpointsopenapijsonretrieve
        method: GET
        description: Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: integer
          description: Specific endpoint version to generate the spec for. Defaults to latest.
    - name: api-environments-environment_id-endpoints-name-run
      path: /api/environments/{environment_id}/endpoints/{name}/run/
      operations:
      - name: environmentsendpointsrunretrieve
        method: GET
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: environmentsendpointsrunretrieve
        method: GET
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: environmentsendpointsruncreate
        method: POST
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsendpointsruncreate
        method: POST
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-endpoints-name-versions
      path: /api/environments/{environment_id}/endpoints/{name}/versions/
      operations:
      - name: environmentsendpointsversionslist
        method: GET
        description: List all versions for an endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: name
          in: path
          type: string
          required: true
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: environmentsendpointsversionslist
        method: GET
        description: List all versions for an endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: name
          in: path
          type: string
          required: true
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
    - name: api-projects-project_id-endpoints
      path: /api/projects/{project_id}/endpoints/
      operations:
      - name: endpointslist
        method: GET
        description: List all endpoints for the team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: endpointslist
        method: GET
        description: List all endpoints for the team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: endpointscreate
        method: POST
        description: Create a new endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointscreate
        method: POST
        description: Create a new endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-endpoints-last_execution_times
      path: /api/projects/{project_id}/endpoints/last_execution_times/
      operations:
      - name: endpointslastexecutiontimescreate
        method: POST
        description: Get the last execution times in the past 6 months for multiple endpoints.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: endpointslastexecutiontimescreate
        method: POST
        description: Get the last execution times in the past 6 months for multiple endpoints.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-endpoints-name
      path: /api/projects/{project_id}/endpoints/{name}/
      operations:
      - name: endpointsretrieve
        method: GET
        description: Retrieve an endpoint, or a specific version via ?version=N.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: endpointsretrieve
        method: GET
        description: Retrieve an endpoint, or a specific version via ?version=N.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: endpointsupdate
        method: PUT
        description: Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param
          to target a specific version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointsupdate
        method: PUT
        description: Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param
          to target a specific version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointspartialupdate
        method: PATCH
        description: Update an existing endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointspartialupdate
        method: PATCH
        description: Update an existing endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointsdestroy
        method: DELETE
        description: Delete an endpoint and clean up materialized query.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: endpointsdestroy
        method: DELETE
        description: Delete an endpoint and clean up materialized query.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: api-projects-project_id-endpoints-name-materialization_preview
      path: /api/projects/{project_id}/endpoints/{name}/materialization_preview/
      operations:
      - name: endpointsmaterializationpreviewcreate
        method: POST
        description: Preview the materialization transform for an endpoint. Shows what the query will look like after materialization,
          including range pair detection and bucket functions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointsmaterializationpreviewcreate
        method: POST
        description: Preview the materialization transform for an endpoint. Shows what the query will look like after materialization,
          including range pair detection and bucket functions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-endpoints-name-materialization_status
      path: /api/projects/{project_id}/endpoints/{name}/materialization_status/
      operations:
      - name: endpointsmaterializationstatusretrieve
        method: GET
        description: Get materialization status for an endpoint. Supports ?version=N query param.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: endpointsmaterializationstatusretrieve
        method: GET
        description: Get materialization status for an endpoint. Supports ?version=N query param.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: api-projects-project_id-endpoints-name-openapi.json
      path: /api/projects/{project_id}/endpoints/{name}/openapi.json/
      operations:
      - name: endpointsopenapijsonretrieve
        method: GET
        description: Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: integer
          description: Specific endpoint version to generate the spec for. Defaults to latest.
      - name: endpointsopenapijsonretrieve
        method: GET
        description: Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: integer
          description: Specific endpoint version to generate the spec for. Defaults to latest.
    - name: api-projects-project_id-endpoints-name-run
      path: /api/projects/{project_id}/endpoints/{name}/run/
      operations:
      - name: endpointsrunretrieve
        method: GET
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: endpointsrunretrieve
        method: GET
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
      - name: endpointsruncreate
        method: POST
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: endpointsruncreate
        method: POST
        description: Execute endpoint with optional materialization. Supports version parameter, runs latest version if not
          set.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-endpoints-name-versions
      path: /api/projects/{project_id}/endpoints/{name}/versions/
      operations:
      - name: endpointsversionslist
        method: GET
        description: List all versions for an endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: name
          in: path
          type: string
          required: true
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: endpointsversionslist
        method: GET
        description: List all versions for an endpoint.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: created_by
          in: query
          type: integer
        - name: is_active
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: name
          in: path
          type: string
          required: true
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
    authentication:
      type: bearer
      token: '{{env.POSTHOG_API_KEY}}'
  exposes:
  - type: rest
    namespace: posthog-endpoints-rest
    port: 8080
    description: REST adapter for PostHog API — endpoints. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/environments/{environment-id}/endpoints
      name: api-environments-environment-id-endpoints
      description: REST surface for api-environments-environment_id-endpoints.
      operations:
      - method: GET
        name: environmentsendpointslist
        description: List all endpoints for the team.
        call: posthog-endpoints.environmentsendpointslist
        with:
          created_by: rest.created_by
          is_active: rest.is_active
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: environmentsendpointslist
        description: List all endpoints for the team.
        call: posthog-endpoints.environmentsendpointslist
        with:
          created_by: rest.created_by
          is_active: rest.is_active
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: environmentsendpointscreate
        description: Create a new endpoint.
        call: posthog-endpoints.environmentsendpointscreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: environmentsendpointscreate
        description: Create a new endpoint.
        call: posthog-endpoints.environmentsendpointscreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environments/{environment-id}/endpoints/last-execution-times
      name: api-environments-environment-id-endpoints-last-execution-times
      description: REST surface for api-environments-environment_id-endpoints-last_execution_times.
      operations:
      - method: POST
        name: environmentsendpointslastexecutiontimescreate
        description: Get the last execution times in the past 6 months for multiple endpoints.
        call: posthog-endpoints.environmentsendpointslastexecutiontimescreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: environmentsendpointslastexecutiontimescreate
        description: Get the last execution times in the past 6 months for multiple endpoints.
        call: posthog-endpoints.environmentsendpointslastexecutiontimescreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/environmen

# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/capabilities/posthog-endpoints.yaml