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 users API

The users API from PostHog — 22 operation(s) for users.

PostHog users 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 User. 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 28 operations across 22 paths, and defines 31 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.

28 operations 22 paths 31 schemas 3 DELETE11 GET3 PATCH10 POST1 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 users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PersonalAPIKeyAuth).

Paths & Operations 28

Across 22 paths, the API surfaces 28 operations — 3 DELETE, 11 GET, 3 PATCH, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

users 28
GET
/api/users/
users_list 4 params → 200
GET
/api/users/{user_id}/signal_autonomy/
Per-user signal autonomy config (singleton keyed by user). GET /api/users/ /signalautonomy/ → current config (or 404) POST /api/users/ /signalautonomy/ → create or update DELETE /api/users/ /signalau…
users_signal_autonomy_retrieve 1 param → 200
POST
/api/users/{user_id}/signal_autonomy/
Per-user signal autonomy config (singleton keyed by user). GET /api/users/ /signalautonomy/ → current config (or 404) POST /api/users/ /signalautonomy/ → create or update DELETE /api/users/ /signalau…
users_signal_autonomy_create 1 param body → 200
DELETE
/api/users/{user_id}/signal_autonomy/
Per-user signal autonomy config (singleton keyed by user). GET /api/users/ /signalautonomy/ → current config (or 404) POST /api/users/ /signalautonomy/ → create or update DELETE /api/users/ /signalau…
users_signal_autonomy_destroy 1 param → 204
GET
/api/users/{uuid}/
Retrieve a user's profile and settings. Pass @me as the UUID to fetch the authenticated user; non-staff callers may only access their own account.
users_retrieve 1 param → 200
PUT
/api/users/{uuid}/
Replace the authenticated user's profile and settings. Pass @me as the UUID to update the authenticated user. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be p…
users_update 1 param body → 200
PATCH
/api/users/{uuid}/
Update one or more of the authenticated user's profile fields or settings.
users_partial_update 1 param body → 200
DELETE
/api/users/{uuid}/
users_destroy 1 param → 204
GET
/api/users/{uuid}/github_login/
users_github_login_retrieve 1 param → 200
GET
/api/users/{uuid}/hedgehog_config/
users_hedgehog_config_retrieve 1 param → 200
PATCH
/api/users/{uuid}/hedgehog_config/
users_hedgehog_config_partial_update 1 param body → 200
GET
/api/users/{uuid}/integrations/
List personal GitHub integrations
users_integrations_list 3 params → 200
DELETE
/api/users/{uuid}/integrations/github/{installation_id}/
Disconnect a personal GitHub integration
users_integrations_github_destroy 2 params → 204
GET
/api/users/{uuid}/integrations/github/{installation_id}/branches/
List branches for a personal GitHub installation repository
users_integrations_github_branches_retrieve 6 params → 200
GET
/api/users/{uuid}/integrations/github/{installation_id}/repos/
List repositories for a personal GitHub installation
users_integrations_github_repos_retrieve 5 params → 200
POST
/api/users/{uuid}/integrations/github/{installation_id}/repos/refresh/
Refresh repositories for a personal GitHub installation
users_integrations_github_repos_refresh_create 2 params → 200
POST
/api/users/{uuid}/integrations/github/start/
Start GitHub personal integration linking
users_integrations_github_start_create 1 param body → 200
POST
/api/users/{uuid}/scene_personalisation/
users_scene_personalisation_create 1 param body → 200
GET
/api/users/{uuid}/start_2fa_setup/
users_start_2fa_setup_retrieve 1 param → 200
POST
/api/users/{uuid}/two_factor_backup_codes/
Generate new backup codes, invalidating any existing ones
users_two_factor_backup_codes_create 1 param body → 200
POST
/api/users/{uuid}/two_factor_disable/
Disable 2FA and remove all related devices
users_two_factor_disable_create 1 param body → 200
GET
/api/users/{uuid}/two_factor_start_setup/
users_two_factor_start_setup_retrieve 1 param → 200
GET
/api/users/{uuid}/two_factor_status/
Get current 2FA status including backup codes if enabled
users_two_factor_status_retrieve 1 param → 200
POST
/api/users/{uuid}/two_factor_validate/
users_two_factor_validate_create 1 param body → 200
POST
/api/users/{uuid}/validate_2fa/
users_validate_2fa_create 1 param body → 200
PATCH
/api/users/cancel_email_change_request/
users_cancel_email_change_request_partial_update body → 200
POST
/api/users/request_email_verification/
users_request_email_verification_create body → 200
POST
/api/users/verify_email/
users_verify_email_create body → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are PatchedUser (40 properties), User (40 properties), Organization (26 properties), TeamBasic (12 properties). Each schema is shown below with its type and property counts.

NullEnum
AutostartPriorityEnum
string
P0 - P0 P1 - P1 P2 - P2 P3 - P3 P4 - P4
ShortcutPositionEnum
string
above - Above below - Below hidden - Hidden
PaginatedUserList
object
4 properties 2 required
PatchedUser
object
40 properties
SignalUserAutonomyConfig
object
5 properties 4 required
ToolbarModeEnum
string
disabled - disabled toolbar - toolbar
UserGitHubIntegrationItem
object
7 properties 5 required
GitHubRepo
object
3 properties 3 required
User
object
40 properties 22 required
PluginsAccessLevelEnum
integer
0 - none 3 - config 6 - install 9 - root
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
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
EffectiveMembershipLevelEnum
integer
GitHubBranchesResponse
object
3 properties 2 required
PendingInvite
object
Shape of each item in UserSerializer.pendinginvites.
5 properties 5 required
UserGitHubIntegrationListResponse
object
1 property 1 required
DefaultExperimentStatsMethodEnum
string
bayesian - Bayesian frequentist - Frequentist
PaginatedUserGitHubIntegrationListResponseList
object
4 properties 2 required
ThemeModeEnum
string
light - Light dark - Dark system - System
ScenePersonalisationBasic
object
2 properties 1 required
TimezoneEnum
string
Africa/Abidjan - Africa/Abidjan Africa/Accra - Africa/Accra Africa/AddisAbaba - Africa/AddisAbaba Africa/Algiers - Africa/Algiers Africa/Asmara - Africa/Asmara…
GitHubReposResponse
object
2 properties 2 required
GitHubReposRefreshResponse
object
1 property 1 required
_User
object
5 properties 5 required
BlankEnum
Organization
object
26 properties 17 required
RoleAtOrganizationEnum
string
engineering - Engineering data - Data product - Product Management founder - Founder leadership - Leadership marketing - Marketing sales - Sales / Success othe…
UserGitHubLinkStartRequest
object
2 properties
UserGitHubLinkStartResponse
object
2 properties 2 required
UserGitHubAccount
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

posthog-users-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 users 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.