PostHog core 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.
Tagged areas include Core. 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
263 operations
across 182 paths,
and defines 137 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.
The identity and technical contract details declared by the specification.
OrganizationMembershipLevelEnum
integer
1 - member 8 - administrator 15 - owner
EventDefinitionRecord
object
Serializer mixin that handles tags for objects.
14 properties
8 required
Cohort
object
22 properties
12 required
PatchedComment
object
13 properties
EnterprisePropertyDefinition
object
Serializer mixin that handles tags for objects.
13 properties
8 required
CohortTypeEnum
string
static - static personproperty - personproperty behavioral - behavioral realtime - realtime analytical - analytical
PatchedSubscription
object
Standard Subscription serializer.
25 properties
CreateGroup
object
3 properties
2 required
CreateLegalDocument
object
Input serializer for POST. Mirrors the submittable fields on the model plus cross-field rules (BAA addon, DPA mode, uniqueness). The view supplies the organiza…
4 properties
4 required
User
object
40 properties
22 required
GitHubRepo
object
3 properties
3 required
ActionEnum
string
add - add remove - remove set - set
PatchedAddPersonsToStaticCohortRequest
object
1 property
Dashboard
object
Serializer mixin that handles tags for objects.
31 properties
16 required
EnforcementModeEnum
string
allow - Allow reject - Reject
PaginatedCohortList
object
4 properties
2 required
OrganizationBasic
object
Serializer for Organization model with minimal attributes to speeed up loading and transfer times. Also used for nested serializers.
9 properties
5 required
GitHubBranchesResponse
object
3 properties
2 required
DashboardTemplateScopeEnum
string
team - Only team global - Global featureflag - Feature Flag
CopyDashboardTileRequest
object
2 properties
2 required
PaginatedLegalDocumentDTOList
object
4 properties
2 required
CohortPersonResultTypeEnum
string
person - person
PatchedCohort
object
22 properties
PaginatedUserGitHubIntegrationListResponseList
object
4 properties
2 required
PaginatedEnterprisePropertyDefinitionList
object
4 properties
2 required
GitHubReposResponse
object
2 properties
2 required
UserBasic
object
9 properties
4 required
OrganizationDomain
object
15 properties
9 required
UserGitHubLinkStartRequest
object
2 properties
EventPropFilterTypeEnum
string
OrganizationOAuthApplication
object
Serializer for organization-scoped OAuth applications (read-only).
7 properties
4 required
BusinessModelEnum
string
b2b - B2B b2c - B2C other - Other
PaginatedDashboardTemplateList
object
4 properties
2 required
Annotation
object
15 properties
8 required
PaginatedCommentList
object
3 properties
1 required
PatchedOrganizationMember
object
8 properties
PaginatedExportedAssetList
object
4 properties
2 required
PropertyGroupOperator
string
RunInsightsResponse
object
1 property
1 required
PropertyDefinitionTypeEnum
string
DateTime - DateTime String - String Numeric - Numeric Boolean - Boolean Duration - Duration
ExportFormatEnum
string
image/png - image/png application/pdf - application/pdf text/csv - text/csv application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - application/vnd…
CopyDashboardTemplate
object
1 property
1 required
PaginatedProjectBackwardCompatBasicList
object
4 properties
2 required
BulkUpdateTagsResponse
object
2 properties
2 required
LegalDocumentDTO
object
Output serializer — what the API returns for every row.
7 properties
7 required
ToolbarModeEnum
string
disabled - disabled toolbar - toolbar
PatchedRole
object
6 properties
WeekStartDayEnum
integer
0 - Sunday 1 - Monday
TargetTypeEnum
string
email - Email slack - Slack webhook - Webhook
SubscriptionFrequencyEnum
string
daily - Daily weekly - Weekly monthly - Monthly yearly - Yearly
PatchedEnterprisePropertyDefinition
object
Serializer mixin that handles tags for objects.
13 properties
OrganizationMember
object
8 properties
7 required
PendingInvite
object
Shape of each item in UserSerializer.pendinginvites.
5 properties
5 required
SharePassword
object
5 properties
4 required
PatchedDashboard
object
Serializer mixin that handles tags for objects.
31 properties
ProjectBackwardCompat
object
Like ProjectBasicSerializer, but also works as a drop-in replacement for TeamBasicSerializer by way of passthrough fields. This allows the meaning of Team to c…
69 properties
17 required
Subscription
object
Standard Subscription serializer.
25 properties
11 required
PromotedPropertiesResponse
object
1 property
1 required
InsightResult
object
InsightSerializer restricted to identifiers + result only.
5 properties
5 required
PaginatedOrganizationInviteList
object
4 properties
2 required
ReorderTilesRequest
object
1 property
1 required
Role
object
6 properties
6 required
CreationModeEnum
string
default - Default template - Template duplicate - Duplicate unlisted - Unlisted (product-embedded)
DocumentTypeEnum
string
BAA - BAA DPA - DPA
PaginatedOrganizationDomainList
object
4 properties
2 required
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
BehavioralFilter
object
21 properties
4 required
UserGitHubLinkStartResponse
object
2 properties
2 required
ProjectSecretAPIKey
object
9 properties
9 required
ExportedAsset
object
Standard ExportedAsset serializer that doesn't return content.
10 properties
7 required
EffectivePrivilegeLevelEnum
integer
PatchedProjectSecretAPIKey
object
9 properties
UserGitHubAccount
object
2 properties
SubscriptionDelivery
object
17 properties
17 required
PatchedFileSystem
object
10 properties
BulkUpdateTagsError
object
2 properties
2 required
PaginatedDashboardBasicList
object
4 properties
2 required
UserGitHubIntegrationItem
object
7 properties
5 required
Comment
object
13 properties
5 required
EnterpriseEventDefinition
object
Serializer mixin that handles tags for objects.
24 properties
15 required
PatchedOrganizationDomain
object
15 properties
LegalDocumentCreator
object
2 properties
2 required
TeamBasic
object
Serializer for Team model with minimal attributes to speeed up loading and transfer times. Also used for nested serializers.
12 properties
12 required
CohortPersonResult
object
11 properties
11 required
BulkUpdateTagsRequest
object
3 properties
3 required
EffectiveMembershipLevelEnum
integer
AnnotationScopeEnum
string
dashboarditem - insight dashboard - dashboard project - project organization - organization recording - recording
PaginatedAnnotationList
object
4 properties
2 required
RestrictionLevelEnum
integer
21 - Everyone in the project can edit 37 - Only those invited to this dashboard can edit
DefaultExperimentStatsMethodEnum
string
bayesian - Bayesian frequentist - Frequentist
PatchedEnterpriseEventDefinition
object
Serializer mixin that handles tags for objects.
24 properties
ThemeModeEnum
string
light - Light dark - Dark system - System
TimezoneEnum
string
Africa/Abidjan - Africa/Abidjan Africa/Accra - Africa/Accra Africa/AddisAbaba - Africa/AddisAbaba Africa/Algiers - Africa/Algiers Africa/Asmara - Africa/Asmara…
DashboardBasic
object
Serializer mixin that handles tags for objects.
19 properties
18 required
SubscriptionDeliveryStatusEnum
string
starting - Starting completed - Completed failed - Failed skipped - Skipped
GitHubReposRefreshResponse
object
1 property
1 required
ProjectBackwardCompatBasic
object
Like ProjectBasicSerializer, but also works as a drop-in replacement for TeamBasicSerializer by way of passthrough fields. This allows the meaning of Team to c…
11 properties
11 required
PaginatedFileSystemList
object
4 properties
2 required
CohortFilter
object
7 properties
3 required
CohortPersonsResponse
object
3 properties
3 required
AvailableSetupTaskIdsEnum
string
ingestfirstevent - ingestfirstevent setupreverseproxy - setupreverseproxy createfirstinsight - createfirstinsight createfirstdashboard - createfirstdashboard t…
DashboardTileResult
object
DashboardTileSerializer restricted to tile id + insight result fields.
2 properties
1 required
ByweekdayEnum
string
monday - Monday tuesday - Tuesday wednesday - Wednesday thursday - Thursday friday - Friday saturday - Saturday sunday - Sunday
CreationTypeEnum
string
USR - user GIT - GitHub
PaginatedUserList
object
4 properties
2 required
ShortcutPositionEnum
string
above - Above below - Below hidden - Hidden
SessionRecordingRetentionPeriodEnum
string
30d - 30 Days 90d - 90 Days 1y - 1 Year 5y - 5 Years
PatchedRemovePersonRequest
object
1 property
PatchedUser
object
40 properties
FileSystem
object
10 properties
5 required
CohortFilterGroup
object
AND/OR group containing cohort filters. Named to avoid collision with analytics Group model.
2 properties
2 required
HogQLFilter
object
3 properties
2 required
PluginsAccessLevelEnum
integer
0 - none 3 - config 6 - install 9 - root
EventPropFilter
object
4 properties
3 required
DashboardTemplate
object
15 properties
4 required
PaginatedGroupList
object
3 properties
1 required
PaginatedOrganizationOAuthApplicationList
object
4 properties
2 required
Group
object
4 properties
3 required
UserGitHubIntegrationListResponse
object
1 property
1 required
CohortFilters
object
1 property
1 required
SharingConfiguration
object
6 properties
3 required
PatchedProjectBackwardCompat
object
Like ProjectBasicSerializer, but also works as a drop-in replacement for TeamBasicSerializer by way of passthrough fields. This allows the meaning of Team to c…
69 properties
PaginatedProjectSecretAPIKeyList
object
4 properties
2 required
ScenePersonalisationBasic
object
2 properties
1 required
PaginatedSubscriptionList
object
4 properties
2 required
BulkUpdateTagsItem
object
2 properties
2 required
PaginatedRoleList
object
4 properties
2 required
PatchedAnnotation
object
15 properties
PaginatedEnterpriseEventDefinitionList
object
4 properties
2 required
Organization
object
26 properties
17 required
PaginatedSubscriptionDeliveryList
object
3 properties
1 required
OrganizationInvite
object
13 properties
7 required
PatchedDashboardTemplate
object
15 properties
PaginatedOrganizationMemberList
object
4 properties
2 required
PersonFilter
object
8 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PostHog publishes across the network.