How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PostHog endpoints API

The endpoints API from PostHog — 16 operation(s) for endpoints.

PostHog endpoints API is one of 139 APIs that PostHog publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 26 operations across 16 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.posthog.com/api.

26 operations 16 paths 50 schemas 2 DELETE12 GET2 PATCH8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.posthog.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

PostHog endpoints API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 26

Across 16 paths, the API surfaces 26 operations — 2 DELETE, 12 GET, 2 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

endpoints 26
GET
/api/environments/{environment_id}/endpoints/deprecated
List all endpoints for the team.
environments_endpoints_list 5 params → 200
POST
/api/environments/{environment_id}/endpoints/deprecated
Create a new endpoint.
environments_endpoints_create 1 param body → 201
GET
/api/environments/{environment_id}/endpoints/{name}/deprecated
Retrieve an endpoint, or a specific version via ?version=N.
environments_endpoints_retrieve 2 params → 200
PUT
/api/environments/{environment_id}/endpoints/{name}/deprecated
Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param to target a specific version.
environments_endpoints_update 2 params body → 200
PATCH
/api/environments/{environment_id}/endpoints/{name}/deprecated
Update an existing endpoint.
environments_endpoints_partial_update 2 params body → 200
DELETE
/api/environments/{environment_id}/endpoints/{name}/deprecated
Delete an endpoint and clean up materialized query.
environments_endpoints_destroy 2 params → 204
POST
/api/environments/{environment_id}/endpoints/{name}/materialization_preview/deprecated
Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.
environments_endpoints_materialization_preview_create 2 params body → 200
GET
/api/environments/{environment_id}/endpoints/{name}/materialization_status/deprecated
Get materialization status for an endpoint. Supports ?version=N query param.
environments_endpoints_materialization_status_retrieve 2 params → 200
GET
/api/environments/{environment_id}/endpoints/{name}/openapi.json/deprecated
Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
environments_endpoints_openapi.json_retrieve 3 params → 200
GET
/api/environments/{environment_id}/endpoints/{name}/run/deprecated
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
environments_endpoints_run_retrieve 2 params → 200
POST
/api/environments/{environment_id}/endpoints/{name}/run/deprecated
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
environments_endpoints_run_create 2 params body → 200
GET
/api/environments/{environment_id}/endpoints/{name}/versions/deprecated
List all versions for an endpoint.
environments_endpoints_versions_list 6 params → 200
POST
/api/environments/{environment_id}/endpoints/last_execution_times/deprecated
Get the last execution times in the past 6 months for multiple endpoints.
environments_endpoints_last_execution_times_create 1 param body → 200
GET
/api/projects/{project_id}/endpoints/
List all endpoints for the team.
endpoints_list 5 params → 200
POST
/api/projects/{project_id}/endpoints/
Create a new endpoint.
endpoints_create 1 param body → 201
GET
/api/projects/{project_id}/endpoints/{name}/
Retrieve an endpoint, or a specific version via ?version=N.
endpoints_retrieve 2 params → 200
PUT
/api/projects/{project_id}/endpoints/{name}/
Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param to target a specific version.
endpoints_update 2 params body → 200
PATCH
/api/projects/{project_id}/endpoints/{name}/
Update an existing endpoint.
endpoints_partial_update 2 params body → 200
DELETE
/api/projects/{project_id}/endpoints/{name}/
Delete an endpoint and clean up materialized query.
endpoints_destroy 2 params → 204
POST
/api/projects/{project_id}/endpoints/{name}/materialization_preview/
Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions.
endpoints_materialization_preview_create 2 params body → 200
GET
/api/projects/{project_id}/endpoints/{name}/materialization_status/
Get materialization status for an endpoint. Supports ?version=N query param.
endpoints_materialization_status_retrieve 2 params → 200
GET
/api/projects/{project_id}/endpoints/{name}/openapi.json/
Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients.
endpoints_openapi.json_retrieve 3 params → 200
GET
/api/projects/{project_id}/endpoints/{name}/run/
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
endpoints_run_retrieve 2 params → 200
POST
/api/projects/{project_id}/endpoints/{name}/run/
Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set.
endpoints_run_create 2 params body → 200
GET
/api/projects/{project_id}/endpoints/{name}/versions/
List all versions for an endpoint.
endpoints_versions_list 6 params → 200
POST
/api/projects/{project_id}/endpoints/last_execution_times/
Get the last execution times in the past 6 months for multiple endpoints.
endpoints_last_execution_times_create 1 param body → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are EndpointVersionResponse (27 properties), EndpointResponse (21 properties), QueryStatus (16 properties), PatchedEndpointRequest (10 properties). Each schema is shown below with its type and property counts.

Breakdown
object
5 properties 1 required
NullEnum
QueryStatus
object
16 properties 2 required
HogQLPropertyFilter
object
4 properties 1 required
GroupPropertyFilter
object
7 properties 2 required
LogEntryPropertyFilter
object
5 properties 2 required
ElementPropertyFilter
object
5 properties 2 required
WorkflowVariablePropertyFilter
object
5 properties 2 required
DataWarehousePropertyFilter
object
5 properties 2 required
EventMetadataPropertyFilter
object
5 properties 2 required
LogPropertyFilter
object
5 properties 3 required
EndpointRequest
object
Schema for creating/updating endpoints. OpenAPI docs only — validation uses Pydantic.
10 properties
ClickhouseQueryProgress
object
5 properties 5 required
MultipleBreakdownType
string
DataWarehousePersonPropertyFilter
object
5 properties 2 required
SpanPropertyFilter
object
5 properties 3 required
DurationType
string
BreakdownType
string
PaginatedEndpointResponseList
object
4 properties 2 required
BreakdownFilter
object
9 properties
EventPropertyFilter
object
5 properties 1 required
EndpointResponse
object
Full endpoint representation returned by list/retrieve/create/update.
21 properties 20 required
EndpointLastExecutionTimesRequest
object
1 property 1 required
SpanPropertyFilterType
string
PropertyOperator
string
EndpointColumn
object
A column in the endpoint's query result.
2 properties 2 required
EndpointVersionResponse
object
Extended endpoint representation when viewing a specific version.
27 properties 26 required
RecordingPropertyFilter
object
5 properties 2 required
QueryStatusResponse
object
1 property 1 required
PaginatedEndpointVersionResponseList
object
4 properties 2 required
MaterializationPreviewRequest
object
2 properties
LogPropertyFilterType
string
Key10
string
PersonPropertyFilter
object
5 properties 2 required
EndpointRunRequest
object
8 properties
UserBasic
object
9 properties 4 required
BlankEnum
FeaturePropertyFilter
object
5 properties 2 required
ErrorTrackingIssueFilter
object
5 properties 2 required
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
EndpointMaterialization
object
Materialization status for an endpoint version.
7 properties 2 required
EmptyPropertyFilter
object
1 property
DashboardFilter
object
5 properties
PatchedEndpointRequest
object
Schema for creating/updating endpoints. OpenAPI docs only — validation uses Pydantic.
10 properties
SessionPropertyFilter
object
5 properties 2 required
EndpointRefreshMode
string
FlagPropertyFilter
object
5 properties 2 required
CohortPropertyFilter
object
6 properties 1 required
RevenueAnalyticsPropertyFilter
object
5 properties 2 required
EndpointRunResponse
object
Response from executing an endpoint query.
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-endpoints-api-openapi.yml Raw ↑

Other APIs PostHog publishes across the network.

PostHog Capture API
PostHog Query API
PostHog Persons API
PostHog Feature Flags API
PostHog Experiments API
PostHog Insights API
PostHog Cohorts API
PostHog Annotations API
PostHog actions API
PostHog activity_log API
PostHog activity_logs API
PostHog advanced_activity_logs API
Where this information came from

This is an independent, third-party profile of PostHog endpoints API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.