How to automate PostHog with AI agents

Retrieve the latest update information for a specific pipeline import app by its id within an organization. this endpoint returns details such as plugin type, name, description, …

Get update status for a specific pipeline transformation plugin by its unique id within an organization. this endpoint requires the 'organization id' and 'plugin' ids and returns…

Projects for the current organization.

This endpoint duplicates a specified cohort as a static one within a project. path parameters include `project id` (string) and cohort `id` (integer). successful requests return …

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

The post endpoint enables creating insights for projects using a project id and supports json/csv. it offers detailed parameters for customizing insights and returns structured d…

Create a new dashboard for a specified project from a template. accepts project id in the path and a json payload with various dashboard object parameters. returns a dashboard in…

Create a domain for a specific organization by post to `/api/organizations/{id}/domains` with json/form data. requires domain, saml setup, and write permissions. returns new doma…

Create a new exposure cohort for an experiment in a project by sending a post request with experiment details and feature flag data. requires experiment id and project id in the …

Manage feature flags by creating, reading, updating, and deleting them. utilize javascript library or endpoint for user-specific flag status. refer to documentation for details.

Manage feature flags by creating, reading, updating, and deleting them using posthog's javascript library or api endpoint. details in the provided documentation.

Create a config for pipeline frontend apps within a specified project. requires project id and payload with object properties such as plugin, enabled status, order, etc. returns …

This endpoint handles reading and deleting persons. for creation or updates, use the capture api, `$set` or `$unset` properties, or sdks.

Post /api/organizations/ - create a new organization with details like name, membership level, and features access. requires organization:write permission. returns organization i…

Create a new experiment in a specific project using json, form, or multipart data. requires project id and experiment details, secured with personalapikeyauth. generates a 201 re…

Send invites with roles (member, admin, owner) via email to join an organization by id. use json, form data, or multipart with a personal api key for security. successful invites…

Create a new role for the specified organization by supplying role details. requires organization id (uuid) and role data in json. returns the created role on success with a 201 …

Create a proxy record for an org by sending org id in url and json/form/multipart data with domain, target cname, and status. requires personalapikeyauth and org write access; re…

This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks to create or update them.

This api endpoint is for reading and deleting users. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating users.

Create pipeline destination configurations for a specific project by submitting plugin and order details, among other configuration info, with required project id. authentication…

Create a job for a pipeline destination config with a specific id within the specified project. requires project id & config id in the path, and a json payload with plugin and or…

A job imports app settings into a project pipeline using project id and plugin config id, accepting json/form/multipart, and specifies plugin details, enabling status, and order …

Create a job-related configuration for a specific plugin by providing plugin and project ids. accepts json, form data, and returns config details on success. use carefully; requi…

This post endpoint creates actions for a project, accepts various data types, requires project id and action data, optionally outputs in csv/json, and needs personalapikeyauth, r…

Create cohorts for a specified project by posting json-form data to \

The post endpoint creates a dashboard within a project using a `project id`, accepting details in json/form formats. it uses 'personalapikeyauth' for security and returns http 20…

Create project insights with optional csv/json format parameter. requires `project id` in the path and a json body with project insight details. supports personal api key authent…

Create pipeline app configurations for a specified project via post, requiring a project id and json, form, or multipart payload. supports configs, plugins, and app details. retu…

Create a job for a pipeline frontend app config in a project. requires `project id` and config `id`, accepting json/form-data. returns the created job's details.

Create a pipeline transformation config within a specific project by posting json, form, or multipart data. include plugin id, order, and enabled status. ensure project id is in …

Create a new plugin configuration for a specified project by post to /api/projects/{project id}/plugin configs/. requires project id and json payload with plugin details; must au…

Create a subscription for a given project by providing required details such as delivery method, frequency, and starting date. requires a project id and supports various content …

Create surveys in a project by providing a project id and details like type, questions, and targets in json, form-data, or urlencoded format. use personalapikeyauth for security.…

Create timing insights for a project by post to /api/projects/{project id}/insights/timing, supporting csv or json. it returns a 200 status with content in the chosen format.

The `/api/projects/{project id}/query/` post endpoint allows users to submit queries for a specific project by providing the project id in the url and the query details in json o…

Create and retrieve retention insights for a project using its id, allowing csv/json outputs. requires an api key with `insight:read` permissions and supports query node json str…

The post endpoint generates a project's session recording, needing 'project id', 'short id', and 'session recording id' in the url, and accepts various content formats for record…

Create playlists of session recordings for a specified project. requires 'project id' path parameter and personal api key with write access. supports json, form-encoded, or multi…

Summarize a session recording by providing the project id and the recording's uuid. get details like duration, activities, and user info.

Manage feature flags for apps with create, read, update, and delete operations using posthog's javascript library or dedicated endpoint. more info in the docs.

Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

The `/api/projects/{project id}/insights/funnel/` endpoint generates customizable funnel insights for a project in either csv or json, offering filtering, exclusion, and ordering…

Delete an organization by its uuid. requires a 'personalapikeyauth' with 'organization:write' permission. on success, returns a 204 status code with no response body.

Projects for the current organization.

This endpoint is used to read and delete user data. use the capture api, `$set`/`$unset` commands, or sdks for creating/updating persons.

Delete a session recording by providing the session's uuid and the associated project id. requires `session recording:write` permission. returns no content on successful deletion.

Delete a survey by providing its uuid and the associated project id. requires 'survey:write' permission. returns no content with a 204 status on success.

Enables a new early access feature for a project using project id, payload with details, and personalapikeyauth. returns a 201 status on success.

Retrieve logs for a specific batch export within a project by its uuid. endpoint requires project id and export id (uuid). supports json responses detailing export properties, ru…

Retrieve pipeline transformation export unsubscribe configurations for a specified organization by its uuid. returns details including id, plugin type, and configuration schema i…

Retrieve activity details for a specific pipeline frontend app config by id within a project. requires both `project id` and config `id` in the path. returns json with app config…

Retrieve organization details by uuid. endpoint requires 'organization:read' access. response includes name, slug, timestamps, membership, plugins access level, and team structure.

Retrieve details of pipeline import app repositories for a specific organization by its uuid. returns json with properties like plugin type, name, and url. supports 'local', 'cus…

Use a get request to '/api/projects/{project id}/pipeline destination configs/{id}/activity/' to get details, status, config, and metrics for a pipeline destination by id, return…

Retrieve details of pipeline transformations from a specified organization's repository. requires `organization id` (uuid). returns json with properties like id, plugin type, and…

Fetch secondary experiment data in a project by its unique id, using project and experiment ids as path parameters. authenticated by personalapikeyauth, it returns a json with ex…

Retrieve the activity log of surveys within a specific project by using the project id. this endpoint requires a personalapikeyauth with 'activity log:read' permission and return…

Retrieve session recording playlist details for a specific project by project id and playlist short id. requires personalapikeyauth with read access. returns playlist metadata in…

Hard delete of this model is not allowed. use a patch api call to set \

The /api/projects/{project id}/insights/funnel/correlation endpoint generates a correlation insight for funnel analysis in a project, accepting json/csv and needing 'project id' …

Retrieve unused pipeline frontend apps for a specific organization by its uuid. returns details like app ids, types, names, descriptions, and other metadata in json format. requi…

Post /api/organizations/{organization id}/domains/{id}/verify/: initiates verification for a domain within an organization using its uuid, updating its verification status and re…

Create a pipeline transformation job for a specified plugin config in a project by posting to `/api/projects/{project id}/pipeline transformation configs/{id}/job/`. requires pro…

This endpoint for listing/filtering events is deprecated and maintained only for compatibility. users are discouraged from using it and should use the query endpoint for ad-hoc l…

Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

Manage feature flags with creation, reading, updating, and deletion capabilities. utilize javascript library or an endpoint for application integration. more details in the docs.

List runs for a batch export by `batch export id` within a project. supports pagination & ordering of the results. requires `batch export:read` permission. returns status, errors…

Retrieve a list of dashboard sharing configurations for a specified project and dashboard. requires dashboard id, project id, and sharing read permission via personalapikeyauth. …

This get endpoint returns role access details for a feature flag in a project, needs 'project id' & 'feature flag id', and offers optional 'limit' & 'offset' for pagination.

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

Retrieve a list of session recording playlists for a specific project. filter by creator, paginate with limit and offset, and identify playlists with project id and optional shor…

This endpoint is for reading/deleting persons. for creating/updating, use the capture api, set/unset properties, or sdks.

Fetch a list of an organization's domains with pagination using `limit` and `offset`. access requires `organization id` and a personalapikeyauth. optional parameters available. p…

Retrieve a paginated list of invites for a specific organization, identified by `organization id`, with optional `limit` and `offset` query params for result customization. requi…

Retrieve members list from an organization with 'limit' and 'offset' options using personalapikeyauth and organization id. access requires organization member:read permission. re…

Retrieve the list of plugins for a specified organization. supports pagination through 'limit' and 'offset' query parameters. requires a valid organization uuid and personalapike…

Fetch a paginated list of roles in an organization using its uuid. supports query parameters for limits and offsets. access needs personalapikeyauth. returns details like id, nam…

Retrieve paginated batch exports for an organization, with filters and optional limits. includes team, interval, and status details. access requires personalapikeyauth with batch…

Retrieve a paginated list of an organization's proxy records by id, with 'limit' and 'offset' options. 'organization id' and 'personalapikeyauth' are necessary. includes status, …

Retrieve a paginated list of an organization's pipeline destinations by id, with optional count and offset parameters. requires personalapikeyauth (plugin:read). returns details …

Retrieve a paginated list of pipeline apps for an organization using 'plugin:read' personalapikeyauth. requires organization id (uuid) and supports limit and offset parameters. i…

Retrieve a paginated list of pipeline import applications for a specified organization by id. supports optional 'limit' and 'offset' query parameters for result pagination. requi…

Retrieve paginated pipeline transformation lists for an organization using `limit` and `offset`, requiring a uuid and personalapikeyauth. supports filtering and detailed views.

Get paginated surveys for a project with its id, using 'limit' and 'offset'. needs personalapikeyauth ('survey:read'). json output includes survey info, links, and metadata.

List pipeline destination configurations for a given project by id, with optional pagination through 'limit' and 'offset' query parameters. returns details such as plugin info an…

Retrieve paginated configurations for pipeline frontend apps associated with a specified project. query parameters 'limit' and 'offset' control pagination. requires a project id …

Get paginated project actions with filters by format. query params: limit, offset. needs personalapikeyauth for read. includes id, name, description, metadata.

Retrieve an indexed list of batch exports for a specified project with optional pagination. view export details, statuses, and pagination links. requires project id and supports …

Retrieve logs for a specific plugin configuration within a project. supports pagination with limit and offset query parameters. requires project and plugin configuration ids. aut…

Get dashboard collaborators list in a project using project string id and dashboard integer id. requires personalapikeyauth and `dashboard:read` permission. returns details like …

Get paginated dashboards for a project by id, using 'limit' and 'offset'. must authenticate with personalapikeyauth. includes count, pagination, and dashboard details.

\

Retrieve a paginated list of a project's early access features by id with 'limit' and 'offset' parameters. an api key is needed. includes feature info like creation date, stage, …

Get a paginated list of experiments within a project using 'limit' and 'offset' parameters. need a valid project id and 'experiment:read' permission. returns details like feature…

Retrieve a paginated list of export items for a specific project by id with optional 'limit' and 'offset' query parameters. requires personalapikeyauth for export:read permission…

Retrieve a list of group types within a specific project by providing the project id. this endpoint requires authentication with a personalapikey and grants read access to group …

Retrieve a list of project membership details for a specified project by id. members and their roles, such as member or admin, are included along with their join and update times…

Fetch paginated pipeline configuration list for a project by its id, utilizing optional `limit` and `offset`. endpoint returns json data.

List pipeline import app configurations for a specified project, with pagination options 'limit' and 'offset'. requires a project id and supports personalapikeyauth for security.…

Retrieve a paginated list of plugin configurations for a specific project by project id. supports optional 'limit' & 'offset' query params for result batching. requires 'personal…

Retrieve a paginated list of session recordings for a specific project, including viewing times and user interactions. specify `project id`, and use optional `limit` and `offset`…

Projects for the current organization.

Retrieve a paginated list of subscriptions for a given project by its id. optional query params include 'limit' for results per page and 'offset' for results starting index. auth…

Retrieve a paginated list of role memberships for a specific role within an organization, including membership details. optional query parameters ‘limit’ and ‘offset’ control pag…

Retrieve a list of sharing configurations for a specific session recording in a project, including creation timestamps and access tokens. requires project and recording ids.

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/

Retrieve a list of unused pipeline transformations for a specified organization, identified by uuid. includes details like name, plugin type, and configuration. supports json res…

Api endpoint fetches a user list with staff filter, pagination (limit, offset), and requires a personal api key. data includes uuids, emails, and organizational details.

Learn to manage feature flags (creation, access, modification, removal) using posthog's docs, with options to use a javascript library or a dedicated endpoint for user-specific f…

Learn to manage feature flags: create, read, update, delete, and check their status using the javascript library or an endpoint. consult the linked docs for details.

Utilize feature flags to manage application features with creation, reading, updating, and deletion. consult posthog's docs or use their js library or endpoint for user-specific …

Manage feature flags in your app with create, read, update, and delete options. use posthog's javascript library or endpoint to verify user access. see documentation for details.

Hard delete of this model is not allowed. use a patch api call to set \

The post endpoint marks an insight as viewed for a specified project, requires `project id` and `id`, supports `csv` or `json` formats, and returns fast-loading serialized data.

Hard delete of this model is not allowed. use a patch api call to set \

Hard delete of this model is not allowed. use a patch api call to set \

Hard delete of this model is not allowed. use a patch api call to set \

Put /api/organizations/{id}/: update organization details by providing a uuid as 'id'. supports json, form-urlencoded, multipart/form-data. requires 'organization:write' permissi…

Endpoint to move a tile within a dashboard by `id`. requires `project id`, accepts json/form-data (e.g., `name`, `pinned`), and returns updated dashboard info.

Endpoint enables partial updates to an experiment in a project using patch, needing `project id`, `experiment id`, and various payload types. returns updated details. authenticat…

Update plugin configuration partially for a specified project using patch on '/api/projects/{project id}/plugin configs/{id}'. requires plugin write authority. accepts json, form…

Patch /api/projects/{project id}/property definitions/{id}/: partially update a specific property definition by uuid in a project. requires property definition:write auth. no res…

Patch method to partially update config of a pipeline frontend app for a project by id. requires write permission on plugin. accepts json, form-data; returns updated config detai…

The patch endpoint supports partial insight updates in a project, allows format specification (csv/json), and requires `personalapikeyauth` and `insight:write` scope for access.

Endpoint patch /api/projects/{project id}/dashboards/{id}: allows partial update of a project's dashboard with specified id. accepts json, form data, and provides a detailed resp…

Learn to manage feature flags (create, read, update, delete) using posthog's docs, with options for javascript library use or dedicated endpoints for user flag status.

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

Post `/api/projects/{project id}/session recordings/{id}/persist`: endpoint for persisting session recording data identified by uuid. requires `project id` and accepts json conta…

This endpoint allows reading and deleting individuals. for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.

This endpoint is for reading and deleting user data. use the capture api, `$set`/`$unset`, or sdks for creating/updating users.

Hard delete of this model is not allowed. use a patch api call to set \

The `/api/projects/{project id}/insights/trend/` endpoint provides project trends in csv/json, requires `project id` and optional parameters, and needs 'personalapikeyauth'. it o…

Patch /api/projects/{project id}/pipeline frontend apps configs/rearrange/: rearrange the config of frontend apps in a project's pipeline. requires project id in the path and a j…

Endpoint `/api/projects/{project id}/pipeline transformation configs/rearrange/` allows for partial updates to the arrangement of pipeline configurations for a given project. acc…

Rearrange app import settings in a project using patch /api/projects/{project id}/... by updating plug-in order and status. requires `project id` and a json with configurations.

\

Patch endpoint to reconfigure the order of plugins within a project by project id. supports json, form, and multipart bodies to update plugin order and status.

Delete a specific domain by its uuid within an organization, given valid organization and domain ids. requires 'organization:write' permission; no response body on success (204).

Delete an early access feature by id from a specified project. requires a uuid for the feature and the project's id. authentication via personalapikeyauth is necessary. no respon…

Delete a specific user (by uuid) from the explicit members of a given project. requires 'project id' and member's 'parent membership user uuid'. returns 204 on success with no re…

Delete /api/projects/{project id}/feature flags/{feature flag id}/role access/{id}: remove role access from a feature flag in a project by id, requiring authorization. expect no …

Delete /api/organizations/{org id}/members/{user uuid}: removes a specific member from an organization using uuids for both entities. requires 'organization member:write' permiss…

Delete a specific batch export by its uuid in an organization. requires personalapikeyauth with batch export:write permission. returns 204 on success with no response body.

Delete a specific pipeline destination in an organization by id. requires an integer 'id' of the destination, and the organization's 'uuid'. auth: personalapikey with plugin:writ…

Delete a specific pipeline transformation plugin for an organization by id. requires a uuid for the organization and an integer for the plugin. auth: personalapikey with write ac…

Delete a specific plugin (by its integer id) from the organization (identified by uuid) with no response body on success. requires plugin:write authorization via personalapikeyau…

Delete a proxy record by id for a specific organization. requires an authenticated user with 'organization:write' permission. on success, it responds with a 204 status and no con…

Delete a role with a specific uuid in an organization. requires 'organization:write' permission. no response body on success (204). path parameters include 'id' and 'organization…

Delete a specific pipeline import app plugin associated with an organization by id. requires a personal api key with write permissions for plugins. responds with no content on su…

Delete a pipeline destination configuration by specifying a unique integer id within a project. requires 'plugin:write' permission via personalapikeyauth. no response body on suc…

Delete a specific pipeline frontend app by its id within an organization. requires the organization id (uuid) and the app's integer id. auth: personalapikeyauth with plugin:write…

Delete a pipeline frontend app configuration for a specific project. requires 'project id' and config 'id' in the path and 'plugin:write' permissions. responds with 204 on succes…

Delete a specific pipeline import app configuration using its id within a project. requires project id and config id, and auth via personalapikeyauth with plugin write access. no…

Delete a specific pipeline transformation configuration by id within a project. requires the project id and configuration id. secured by personalapikeyauth with plugin:write acce…

Remove a collaborator from a project dashboard. provide the project id, dashboard id, and user's uuid. requires 'dashboard:write' permissions. expect no response body on success …

Delete an event definition by providing its uuid and the associated project id. requires `event definition:write` permission. successful deletion returns no content (204 status).

Delete a specific experiment by its unique integer id within a project. requires a project id and personal api key with experiment write permission. no response body upon success.

Delete /api/projects/{project id}/plugin configs/{id}/: removes a specific plugin configuration by id from a given project. requires 'plugin:write' permissions and project id. re…

Delete a property definition by providing its uuid and the associated project id. requires 'property definition:write' permission. on success, no response body is returned (204).

Delete /api/organizations/{org id}/roles/{role id}/role memberships/{id}: removes a role membership from an organization using a specific uuid. requires write access. returns 204…

Delete a session recording from a playlist using its id within a specified project. requires project id, short id, and session recording id in the path. returns no content on suc…

Delete a specific batch export by providing the uuid and project id. requires a personal api key with 'batch export:write' permissions. responds with no body upon successful dele…

(experimental)

This endpoint is for reading and deleting persons. use the capture api, `$set`/`$unset` properties, or sdks for creating/updating persons.

Retrieve app-specific metrics for a given project by providing the project id and app metric id. requires a personal api key with plugin:read access. no response body provided up…

Retrieves detailed error information for a specific app metric by id within a project. requires project id and metric's integer id as path parameters. no response body for a succ…

(experimental)

Retrieve details of a specific batch export by its uuid in a project. requires project id and batch export id. supports personalapikeyauth and responds with export details includ…

Retrieve logs for a specific batch export given by uuid within an organization. essential for tracking export status, errors, and configurations. supports json responses detailin…

Retrieve logs for a specific batch export run within a project. requires `project id`, `batch export id`, and `id` (all uuids). the endpoint returns run status, error info, recor…

Retrieve activity details for a specific cohort within a project. requires a project id and cohort id, returning status, filters, query, and creator data. auth: personalapikeyaut…

Retrieve details of persons within a cohort by its unique id in the specified project. the endpoint supports json and csv formats and requires authorization. project and cohort i…

Fetch specific dashboard template details by uuid in a project with 'dashboard template:read' rights using a personalapikeyauth. returns name, description, filters, and creation …

Retrieve the json schema for dashboard templates of a specific project. pass the project id in the path and receive details such as template name, description, filters, and more.…

Retrieve an event definition by its uuid within a specified project. requires a project id and an event definition id, with access secured by personalapikeyauth. (get /api/projec…

Retrieve definitions for events within a specified project by providing the unique project id. requires personalapikeyauth privileges for event definition:read. no response body …

Access detailed experiment info within a project using unique `experiment id` & `project id`, with 'experiment:read' rights. response includes dates, feature flag key, metrics, c…

Retrieve details for experiments that require feature flag implementation in a specific project. requires a valid 'project id' and user must have 'experiment:read' permission. re…

Retrieve the configuration for unsubscribing from exports in the pipeline import apps for a specific organization. requires an organization uuid in the path. returns various prop…

Manage feature flags (creation, reading, updating, and deleting) using posthog's guides or via javascript library/endpoint for user-specific flag status. [details](https://postho…

This guide details how to manage (create, read, update, delete) feature flags in applications using posthog's javascript library or endpoint. for more info, visit the provided do…

Retrieve details for a specific role's access to a feature flag within a project. requires 'feature flag id', 'id' for role access, and 'project id'. returns a json object with a…

Learn to manage feature flags by creating, reading, updating, and deleting them. use posthog's javascript library or endpoint for application integration. details in the [docs](h…

Manage feature flags—create, read, update, delete—using the posthog javascript library or endpoint for user-specific flag status. (more in docs).

Get property definitions for a project using project id, with filters for event names, property types, exclusions, and numerical or feature flags. also, view properties relevant …

Gain insights from funnel analysis of a specific project by providing its id and having 'insight:read' permission. supports json/csv formats and offers detailed info like creatio…

Retrieve property definitions for a group within a project by providing the project id. this endpoint returns details like group type index, key, and creation time in json format.

Retrieve property values by 'group type index' and 'key' within a 'project id'. parameters must be provided. output is a json with property details and creation timestamp.

Retrieve user's hedgehog configuration details by their uuid. this endpoint requires the user's uuid as a path parameter and returns various user-related settings such as email, …

Retrieve historical export data for app metrics by supplying the `project id` and `plugin config id`. requires `plugin:read` permission. no response body provided upon a successf…

Retrieve a log of important changes for a specified project. requires a `project id` and returns details about the change, including user info, read status, and timestamps. use `…

Retrieve sharing configurations for a specific insight within a project, requiring project and insight ids. validates access via personalapikeyauth. returns data such as creation…

Returns basic details about the last 5 insights viewed by this user. most recently viewed first.

Retrieves event ids matching a filter with one session id and at least one event/action criterion. intended for internal use and may have sudden changes.

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

This endpoint is for reading and deleting person data; use the capture api, `$set`/`$unset` properties, or sdks for creation and updates.

This api endpoint is for reading and deleting user data. use the capture api, `$set` and `$unset` properties, or sdks for creating/updating users.

Retrieve pipeline frontend app details for an organization using its 'organization id' (uuid). response includes id, plugin type, name, url in json format, covering various plugi…

Retrieve unsubscribe config details for an organization's pipeline frontend apps. requires an organization id (uuid). returns json with config data including plugin types and more.

Retrieve activity details for plugins in a specified organization by id. supports various plugin types, including local, custom, and repository. response includes plugin's id, na…

Retrieve a specific plugin's details for an organization. requires the plugin's integer id and the organization's uuid. only returns plugin info if authenticated with 'plugin:rea…

Retrieve plugin repository details for a specific organization by its uuid, including plugin type, name, url, and more. accessible via get request to '/api/organizations/{organiz…

Retrieve plugin export unsubscribe configurations for a specified organization by organization id. supports local, custom, repository, source, and inline plugin types, providing …

Projects for the current organization.

Retrieve the details of a specific role within an organization using its uuid. requires the organization's uuid and role's uuid in the path and is protected by personalapikeyauth…

Retrieve details for repository pipeline destinations within a specific organization by its uuid. returns objects like id, name, and urls with support for various plugin types (l…

Retrieve unused pipeline import apps for a specified organization. endpoint requires an organization id (uuid) and returns details like plugin type, name, description, and more i…

Retrieve pipeline transformation activity details for a specific organization using its uuid. returns data such as plugin type, name, description, and related metrics. requires '…

Retrieve a paginated list of organizations with optional 'limit' and 'offset' query parameters. the response includes organization details like id, name, and membership level, wi…

This endpoint is used to read and delete persons. for creating or updating, use the capture api, `$set` and `$unset` properties, or sdks.

This endpoint allows reading and deleting persons; for creation or updates, use the capture api, the `$set` and `$unset` properties, or sdks.

This endpoint is for reading and deleting persons. use the capture api, property methods, or sdks for creating or updating persons.

This endpoint allows reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.

This endpoint is for reading and deleting persons; for creating/updating, use the capture api, `$set`/`$unset` properties, or sdks.

This endpoint is for reading and deleting persons. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.

This endpoint is for reading and deleting persons. for creation or updates, use the [capture api](https://posthog.com/docs/api/capture), `$set`/`$unset`, or sdks.

Retrieve activity details for pipeline destinations within an organization. required: uuid-formatted `organization id`. outputs application/json with attributes: id, latest tag, …

Retrieve details of a specific pipeline destination config for a project by its id. requires project id and destination config id. supports personalapikeyauth for read access. re…

Fetch a pipeline destination's details by id and organization uuid, using a personalapikeyauth with read access to plugins. returns json with plugin info.

Retrieve configuration details for a specific pipeline destination in a project by getting the frontend data of the config with a given id. this endpoint requires the 'project id…

Retrieve details of a specific pipeline destination plugin within an organization by its unique id. the response includes various properties like name, description, url, and plug…

Retrieve activity details for pipeline front-end apps within a specified organization by organization id. returns json object with app properties such as id, type, name, and conf…

Retrieves details of a specified pipeline frontend app within an organization. requires plugin read access and organization id (uuid), and app id (integer) as path parameters. re…

Retrieve details for a specific pipeline frontend app's source by its id within an organization. requires an integer id of the app and uuid of the organization. returns json obje…

Retrieve the frontend configuration for a specific plugin in a project's pipeline. requires project and config ids and returns details like plugin info, status, and creation time…

Access specific pipeline import app details in an organization using its id and a valid organization uuid. requires 'personalapikeyauth' with 'plugin:read' access. outputs app pr…

Retrieve activity details of pipeline import apps for a given organization. requires 'organization id' (uuid). returns app id, type, name, url, and other metadata. supports 'loca…

Retrieves source details of a pipeline import app by its id within a specified organization. expects `organization id` (uuid) and `id` (integer) as path parameters. returns app p…

Retrieve pipeline transformation plugin details by id for a specified organization. requires authentication and provides information like plugin type, name, and configuration for…

Retrieve the source details of a pipeline transformation for a specific plugin by id within an organization. access plugin metadata, like its type, url, and config, relevant to o…

Retrieve the activity details of a specific pipeline transformation configuration in a project using its unique integer id. requires project id. returns json including config, pl…

Retrieve the configuration for a specific pipeline transformation plugin in a project by its id using a get request. requires project id and plugin config id in the path and 'plu…

Retrieve the frontend configuration details for a specific pipeline transformation by id within a given project. this endpoint requires the project id and transformation config i…

Retrieve activity details for a specific plugin config within a project's pipeline import apps. requires 'project id' and plugin config 'id' within the api path.

Retrieve activity details for a specific plugin configuration within a project. requires `project id` and unique `id` of the plugin config. responds with plugin info, status, and…

Retrieve the configuration details of a specific plugin by its id for a given project. this endpoint requires a project id and plugin config id, with read permission, and returns…

Retrieve the frontend configuration of an app's pipeline import by id within a specified project. requires `project id` and `id` of the plugin config. returns json object with co…

Retrieve the frontend configuration of a specific plugin for a given project. requires the project id and plugin config id. provides details including plugin state, order, and re…

Retrieve plugin source details by organization and plugin id. requires integer 'id' for the plugin and 'organization id' as uuid. responds with plugin attributes including type, …

This endpoint retrieves update information for a specific plugin within an organization's pipeline frontend app by its integer id and the organization's uuid. it returns details …

Retrieve the latest update status for a specific plugin, identified by its integer id, within an organization specified by uuid. check compatibility and change logs.

Get details on a project action by id. supports json/csv format via query. needs 'project id' and 'id' path parameters. secured by personalapikeyauth.

Projects for the current organization.

Retrieve activity insights for a specific project by project id, supporting csv or json formats. requires an api key with activity log:read permission. limited to essential data …

Access a project's activity log using pagination and cursor-based navigation. requires project id and personalapikeyauth. outputs activity list with user data and timestamps.

Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

Retrieve detailed information about a specific cohort within a project using its id. requires project id and cohort id; returns cohort details including name, creator info, and s…

Retrieve activity log for a specific project's cohorts. requires a project id and personalapikeyauth with activity log:read permission. response includes cohort details and creat…

Retrieve a paginated list of cohorts for a specific project using `project id`. supports `limit` and `offset` query params to customize the response. requires `personalapikeyauth…

Retrieve the draft sql query for a specific project using its project id. ensure to obtain the project id by calling /api/projects/. note: this endpoint does not return a respons…

Retrieve details of a specific early access feature in a project by id. requires project id and feature uuid. must have 'early access feature:read' permission. returns feature de…

Retrieve details for a specific event by id within a project. supports csv or json format. requires project id in path and adheres to personalapikeyauth for security.

Retrieve event values for a specific project by id. supports querying in csv or json format. requires a project id and personal api key with query:read permission. responds with …

Retrieve experiment results within a project by project and experiment id. requires project id and experiment id in the path. returns experiment details in json, with authenticat…

Retrieve detailed info on a specific export of a project using its unique id. requires project id and supports various export formats like png, pdf, csv, and xlsx. auth: personal…

Retrieve insights about funnel correlations for a specific project by id, offering results in json or csv. supports querying and output formatting, with a focus on fast loading o…

Retrieves specified group details within a project by group key and type index. requires 'group key', 'group type index', and 'project id'. responds with group details, including…

Retrieve insights activity for a specific project and insight id, offering data in json or csv format. requires project id and insight id in the path, with optional data format q…

Retrieve details for a specific project insight by id, with options to format as json/csv, request refresh, and specify dashboard context. supports personalapikeyauth with insigh…

Retrieve detailed insights for a specific project using its id. queries can be made in csv or json format. requires 'insight:read' permission. results include various metadata li…

The get `/api/projects/{project id}/insights/` endpoint retrieves a paginated list of insights for a specified project. filter by creator, response format (csv/json), and use lim…

Retrieve detailed information about a specific user's membership level and status within a project by their uuid. access project members' data, roles, and timestamps. (get /api/p…

This endpoint allows reading and deleting individuals. for creating or updating, use the capture api, `$set`/`$unset` properties, or sdks.

This endpoint allows reading and deletion of persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.

This endpoint allows for reading and deleting persons. for creations or updates, use the capture api, set/unset properties, or sdks.

Retrieve configuration details of a specific plugin for a given project pipeline by id. requires a valid project id and plugin config id. supports personalapikeyauth for 'plugin:…

Retrieve session values for a specified project. pass the project id in the url path to obtain the information. only the project's id is required as a parameter. no response body…

Retrieve a specific subscription for a project, identified by 'project id' and 'id'. requires valid api key with read access. supports get method, returns subscription details in…

Retrieve trend insights for a specific project, supporting csv or json formats. mandatory project id required. provides details on insight cache status, creator, and associated d…

Allows a caller to provide a list of event names and a single property name returns a map of the event names to a boolean representing whether that property has ever been seen wi…

Retrieve details of a specific property definition by uuid within a project. requires project id and property definition id. security: personalapikeyauth with read access. no res…

Retrieve a specific proxy record's details by id within an organization. requires path parameters 'organization id' and 'id'. returns json data including domain, status, and time…

Retrieve related groups for a specific project and user. requires 'project id' (path), 'group type index', and user 'id' (query). returns group details with type, key, and creati…

Retrieve retention insights for a specified project. options to output in csv or json format. requires a project id and supports query customization. authenticated access with 'i…

Retrieve property definitions for a specific project by providing the project's id. access this get endpoint at `/api/projects/{project id}/sessions/property definitions/`. proje…

Retrieve detailed information about a specific session recording by providing the session's uuid and associated project id. the response includes metrics such as duration, activi…

Retrieve error clusters from session recordings for a specified project. this endpoint provides details on user interactions, console logs, and activity times in json format, req…

Retrieve session recording playlists for a specified project and playlist short id. returns details like name, creator info, and recordings. access by making a get request to `/a…

Retrieve properties of session recordings for a given project by id, including activity metrics, timestamps, and participant details. requires project id in the path. returns jso…

Snapshots for a session can be loaded from s3 (if old) or redis (if recent). clients call the api without a source to get supported sources, then per source for snapshots. api v1…

Retrieve similar session recordings for a given session by uuid within a project. details include session activity data, user info, and timestamps. requires `project id` and sess…

Retrieve details of a specific batch export for an organization by its uuid. requires a personalapikeyauth with 'batch export:read' permission. responses include export details l…

Retrieve details for a specific batch export run within a project by id. requires a uuid for batch export id and run id. provides run status, record count, timestamps, latest err…

Retrieve details of a specific domain within an organization using its uuid. authorized users can check domain verification status and saml configuration. requires the `personala…

Retrieve the content of a specific exported asset by id within a project. requires 'export:read' permission. supports fetching details like creation time, format (png, pdf, csv, …

Retrieve historical export data for a specific plugin configuration within a project. requires project, plugin config, and export item ids. auth via personalapikeyauth. no body i…

Retrieve the configuration details of a specific pipeline frontend app by providing its unique id and the associated project id. permissions: 'plugin:read'. response includes plu…

Retrieve details of a specific dashboard within a project. requires a dashboard id & project id, and returns information such as dashboard properties, owner, and access levels. a…

Retrieve activity logs for specific survey in a project, identified by uuids. requires valid api key with 'activity log:read' permissions. supports json response detailing survey…

Retrieve survey details using survey uuid and associated project id. supports secure access with 'personalapikeyauth'. returns survey name, type, linking, targeting flags, creato…

Retrieve the count of survey responses for a specific project by its id. it requires the project id parameter and returns details like the survey type, linked flags, and creator …

Retrieve config details for unsubscribed pipeline destinations in an organization. requires 'organization id' (uuid). returns plugin info, name, description, and more in json for…

Retrieve a list of unused plugins for a specified organization by its uuid. the response includes plugin details such as type, name, and configuration. access restricted to the s…

Retrieve unused pipeline destinations for a specified organization by id. this get endpoint returns a json object with details like destination id, plugin type, and url, among ot…

The endpoint `get /api/users/{uuid}/start 2fa setup/` fetches details for initiating 2fa setup for a user, providing information like email status, password presence, and more. f…

Fetch user info like profile, team, org, and notifications via uuid using personalapikeyauth ('user:read'). returns json with name, email, teams, and status.

Delete an organization invite by its uuid. requires a valid personalapikeyauth with organization member write permission. no response body returned on success (http 204).

Hard delete of this model is not allowed. use a patch api call to set \

Hard delete of this model is not allowed. use a patch api call to set \

Hard delete of this model is not allowed. use a patch api call to set \

Hard delete of this model is not allowed. use a patch api call to set \

This endpoint allows reading and deleting persons; for creation or updates, use the capture api, `$set`/`$unset` properties, or sdks.

The `/api/projects/{project id}/exports/` endpoint triggers a project export, requiring `project id` and `export format`. it accepts json, form-encoded, and multipart data, respo…

Create, read, update and delete annotations. [see docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.

This patch endpoint updates a specific early access project feature. it requires `project id` and `id` (uuid) as path parameters. the body can include feature details like `name`…

Update an event definition by sending a put request to '/api/projects/{project id}/event definitions/{id}/' using the uuid and project id, provided you have 'event definition:wri…

Update an experiment by sending a put request with `project id` and `id`, including new details as json/form data. changes to name, description, dates, etc., allowed. `experiment…

Manage feature flags for your app with creation, reading, updating, and deletion options. utilize posthog's js library or endpoint for flag status. more info in docs.

Update specific details of an organization using its uuid. allows patch requests with json, form data, or multipart. requires `organization:write` permission. returns updated org…

Update a domain's info for a specific organization by id, including verification status and saml configuration. requires uuid path params and supports json, form-data content typ…

Updates selected properties of a domain in an organization via patch request, supports various data formats but saml fields are immutable. authentication needed.

Patch '/api/organizations/{id}/members/{uuid}': updates org member with user and org uuids. supports json/form/multipart. returns member data. secured by personalapikeyauth.

Update member details in an organization by id and user uuid. requires org member write permission. accepts json, form, or multipart. responses reflect member info, including rol…

Update a proxy record's domain details for a specified organization and proxy record id using put. requires organization and record ids, supports json, form, and multipart data. …

Update partial cohort details for a specific project. requires a cohort id and project id, supports json, form data, and accepts patch changes like name or description. returns u…

Patch /api/organizations/{organization id}/roles/{id}/: update partial details of a role by id within an organization, including name and feature flag access level. requires uuid…

Patch /api/projects/{project id}/subscriptions/{id}/: update partial details of a specific project subscription by id. modify target, frequency, and more. requires subscription:w…

Update partial survey details by patch to /api/projects/{project id}/surveys/{id}/ with uuid. edit attributes like name, type, questions, targeting, and flags. needs personalapik…

Request data's \

This endpoint allows for reading and deleting individuals. use the capture api, `$set` and `$unset` properties, or sdks for creating or updating persons.

Update the configuration for a pipeline destination in a project. accepts a json, form-urlencoded, or multipart data payload to modify plugin settings by providing project and co…

Update configuration for a specific pipeline frontend app by providing its id and the project id. configure details like activation, order, and optional parameters via json or fo…

Update a project-specific pipeline plugin configuration by supplying the project id and config id. this put request expects details like plugin state, order, and more in json, fo…

Update a pipeline transformation configuration for a specific project and config id. requires project id and config id in the path and json payload. supports plugin activation an…

Update a plugin config's partial details in a project by its id using patch. requires project id, config id. accepts json/form data. authenticated with personalapikeyauth. return…

Put endpoint '/api/projects/{project id}/actions/{id}/' updates actions in a project by id, accepts json/form data, supports 'format' query, and needs 'action:write' authenticati…

Update an action within a project with a specified id. supports partial updates. accepts json, form-data, and query parameters including 'project id' and 'id'. formats response i…

Update cohort details of a specific project by id. requires project and cohort id in the path and a json, form-encoded, or multipart form body. permissions: cohort:write. returns…

Endpoint to update an existing dashboard within a project. provide `project id` and `dashboard id` in path, send json or form data with dashboard details. requires `dashboard:wri…

Update a specific early access feature of a project by providing the `project id` and feature `id` (uuid). requires a json body with feature details and responds with the updated…

Update an existing event definition for a specified project using its uuid. requires a project id and event definition write permissions. responds without a body on success.

Patch /api/projects/{project id}/groups types/update metadata: update group type metadata for a specific project using its project id. can modify name singular and name plural fi…

Endpoint \

Update a project member's role using their uuid in a specific project. accepts partial data to modify membership details such as role level, provided the member's uuid and projec…

Update explicit project membership using uuids. this put endpoint modifies a project member's role, where '1' stands for member and '8' for administrator. requires `project id` a…

The api for interacting with notebooks. this feature is in early access and the api can have breaking changes without announcement.

Update a project's pipeline destination config by id via patch api request. supports json/form requests, with fields like plugin & order. requires personalapikeyauth.

Update a specific pipeline transformation configuration for a project by providing a `project id` and configuration `id`. this patch request can modify properties like `plugin`, …

Update project plugin config using its integer id and project string id; accepts json, url-encoded, or form-data. requires authentication; returns the updated config.

Update a property definition in a project by its uuid. requires a project id and definition id, both as path parameters. security: personalapikeyauth with write access. no body i…

Update an existing session recording playlist for a project with the specified project id and playlist short id. requires json or form data input to modify the playlist's propert…

Update a subscription for a specific project. provide project id and subscription id in the path and use mime types like application/json with fields like frequency, target type,…

The `/api/projects/{project id}/surveys/{id}/` put endpoint updates survey details in a project using survey uuid and project id, accepts json/form/multipart data, needs `survey:…

Update an organization role by submitting its uuid and organization id in uuid format. role details must be in json or form-data. only users with 'organization:write' can do this…

Update session recording playlists using patch on the endpoint with `project id` and `short id`. accepts json and forms data for detail amendments. partial updates allowed. `pers…

Patch `/api/organizations/{organization id}/proxy records/{id}/`: update specific fields of a proxy record by id within an organization. supports json, form data, and multipart. …