Organizations API Reference

Organizations

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`	`/api/organizations/`
`POST`	`/api/organizations/`
`GET`	`/api/organizations/:id/`
`PATCH`	`/api/organizations/:id/`
`DELETE`	`/api/organizations/:id/`
`GET`	`/api/organizations/:organization_id/batch_exports/`
`POST`	`/api/organizations/:organization_id/batch_exports/`
`GET`	`/api/organizations/:organization_id/batch_exports/:id/`
`PATCH`	`/api/organizations/:organization_id/batch_exports/:id/`
`DELETE`	`/api/organizations/:organization_id/batch_exports/:id/`
`POST`	`/api/organizations/:organization_id/batch_exports/:id/backfill/`
`GET`	`/api/organizations/:organization_id/batch_exports/:id/logs/`
`POST`	`/api/organizations/:organization_id/batch_exports/:id/pause/`
`POST`	`/api/organizations/:organization_id/batch_exports/:id/unpause/`
`GET`	`/api/organizations/:organization_id/domains/`
`POST`	`/api/organizations/:organization_id/domains/`
`GET`	`/api/organizations/:organization_id/domains/:id/`
`PATCH`	`/api/organizations/:organization_id/domains/:id/`
`DELETE`	`/api/organizations/:organization_id/domains/:id/`
`POST`	`/api/organizations/:organization_id/domains/:id/verify/`
`GET`	`/api/organizations/:organization_id/invites/`
`POST`	`/api/organizations/:organization_id/invites/`
`DELETE`	`/api/organizations/:organization_id/invites/:id/`
`POST`	`/api/organizations/:organization_id/invites/bulk/`
`GET`	`/api/organizations/:organization_id/members/`
`PATCH`	`/api/organizations/:organization_id/members/:user__uuid/`
`DELETE`	`/api/organizations/:organization_id/members/:user__uuid/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/`
`POST`	`/api/organizations/:organization_id/pipeline_destinations/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/:id/`
`PATCH`	`/api/organizations/:organization_id/pipeline_destinations/:id/`
`DELETE`	`/api/organizations/:organization_id/pipeline_destinations/:id/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/:id/source/`
`PATCH`	`/api/organizations/:organization_id/pipeline_destinations/:id/update_source/`
`POST`	`/api/organizations/:organization_id/pipeline_destinations/:id/upgrade/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/activity/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/exports_unsubscribe_configs/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/repository/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/unused/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/`
`POST`	`/api/organizations/:organization_id/pipeline_frontend_apps/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/`
`PATCH`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/`
`DELETE`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/source/`
`PATCH`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/update_source/`
`POST`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/upgrade/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/activity/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/exports_unsubscribe_configs/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/repository/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/unused/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/`
`POST`	`/api/organizations/:organization_id/pipeline_import_apps/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/:id/`
`PATCH`	`/api/organizations/:organization_id/pipeline_import_apps/:id/`
`DELETE`	`/api/organizations/:organization_id/pipeline_import_apps/:id/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/:id/source/`
`PATCH`	`/api/organizations/:organization_id/pipeline_import_apps/:id/update_source/`
`POST`	`/api/organizations/:organization_id/pipeline_import_apps/:id/upgrade/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/activity/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/exports_unsubscribe_configs/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/repository/`
`GET`	`/api/organizations/:organization_id/pipeline_import_apps/unused/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/`
`POST`	`/api/organizations/:organization_id/pipeline_transformations/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/:id/`
`PATCH`	`/api/organizations/:organization_id/pipeline_transformations/:id/`
`DELETE`	`/api/organizations/:organization_id/pipeline_transformations/:id/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/:id/source/`
`PATCH`	`/api/organizations/:organization_id/pipeline_transformations/:id/update_source/`
`POST`	`/api/organizations/:organization_id/pipeline_transformations/:id/upgrade/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/activity/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/exports_unsubscribe_configs/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/repository/`
`GET`	`/api/organizations/:organization_id/pipeline_transformations/unused/`
`GET`	`/api/organizations/:organization_id/plugins/`
`POST`	`/api/organizations/:organization_id/plugins/`
`GET`	`/api/organizations/:organization_id/plugins/:id/`
`PATCH`	`/api/organizations/:organization_id/plugins/:id/`
`DELETE`	`/api/organizations/:organization_id/plugins/:id/`
`GET`	`/api/organizations/:organization_id/plugins/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/plugins/:id/source/`
`PATCH`	`/api/organizations/:organization_id/plugins/:id/update_source/`
`POST`	`/api/organizations/:organization_id/plugins/:id/upgrade/`
`GET`	`/api/organizations/:organization_id/plugins/activity/`
`GET`	`/api/organizations/:organization_id/plugins/exports_unsubscribe_configs/`
`GET`	`/api/organizations/:organization_id/plugins/repository/`
`GET`	`/api/organizations/:organization_id/plugins/unused/`
`GET`	`/api/organizations/:organization_id/projects/`
`POST`	`/api/organizations/:organization_id/projects/`
`GET`	`/api/organizations/:organization_id/projects/:id/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/`
`DELETE`	`/api/organizations/:organization_id/projects/:id/`
`GET`	`/api/organizations/:organization_id/projects/:id/activity/`
`GET`	`/api/organizations/:organization_id/projects/:id/is_generating_demo_data/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/reset_token/`
`GET`	`/api/organizations/:organization_id/proxy_records/`
`POST`	`/api/organizations/:organization_id/proxy_records/`
`GET`	`/api/organizations/:organization_id/proxy_records/:id/`
`PATCH`	`/api/organizations/:organization_id/proxy_records/:id/`
`DELETE`	`/api/organizations/:organization_id/proxy_records/:id/`
`GET`	`/api/organizations/:organization_id/roles/`
`POST`	`/api/organizations/:organization_id/roles/`
`GET`	`/api/organizations/:organization_id/roles/:id/`
`PATCH`	`/api/organizations/:organization_id/roles/:id/`
`DELETE`	`/api/organizations/:organization_id/roles/:id/`
`GET`	`/api/organizations/:organization_id/roles/:role_id/role_memberships/`
`POST`	`/api/organizations/:organization_id/roles/:role_id/role_memberships/`
`DELETE`	`/api/organizations/:organization_id/roles/:role_id/role_memberships/:id/`

Retrieve

Required API key scopes

organization:read

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "membership_level": 1,
      "plugins_access_level": 0,
      "teams": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "available_product_features": [
        null
      ],
      "is_member_join_email_enabled": true,
      "metadata": "string",
      "customer_id": "string",
      "enforce_2fa": true,
      "member_count": "string"
    }
  ]
}

Retrieve

Required API key scopes

organization:read

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "slug": "string",
      "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "membership_level": 1,
      "plugins_access_level": 0,
      "teams": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "available_product_features": [
        null
      ],
      "is_member_join_email_enabled": true,
      "metadata": "string",
      "customer_id": "string",
      "enforce_2fa": true,
      "member_count": "string"
    }
  ]
}

Create

Required API key scopes

organization:write

Request parameters

name
string
logo_media_id
string
is_member_join_email_enabled
boolean
enforce_2fa
boolean

Response

Request

POST /api/organizations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/\
	-d name="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": "string",
  "customer_id": "string",
  "enforce_2fa": true,
  "member_count": "string"
}

Create

Required API key scopes

organization:write

Request parameters

name
string
logo_media_id
string
is_member_join_email_enabled
boolean
enforce_2fa
boolean

Response

Request

POST /api/organizations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/\
	-d name="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": "string",
  "customer_id": "string",
  "enforce_2fa": true,
  "member_count": "string"
}

Retrieve

Required API key scopes

organization:read

Path parameters

id
string
A UUID string identifying this organization.

Response

Request

GET /api/organizations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": "string",
  "customer_id": "string",
  "enforce_2fa": true,
  "member_count": "string"
}

Retrieve

Required API key scopes

organization:read

Path parameters

id
string
A UUID string identifying this organization.

Response

Request

GET /api/organizations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": "string",
  "customer_id": "string",
  "enforce_2fa": true,
  "member_count": "string"
}

Update partial

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this organization.

Request parameters

name
string
logo_media_id
string
is_member_join_email_enabled
boolean
enforce_2fa
boolean

Response

Request

PATCH /api/organizations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:id/\
	-d name="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": "string",
  "customer_id": "string",
  "enforce_2fa": true,
  "member_count": "string"
}

Update partial

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this organization.

Request parameters

name
string
logo_media_id
string
is_member_join_email_enabled
boolean
enforce_2fa
boolean

Response

Request

PATCH /api/organizations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:id/\
	-d name="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "logo_media_id": "a5d9f2f1-d934-4d2e-bebe-4b3cdcd08a33",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "membership_level": 1,
  "plugins_access_level": 0,
  "teams": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "available_product_features": [
    null
  ],
  "is_member_join_email_enabled": true,
  "metadata": "string",
  "customer_id": "string",
  "enforce_2fa": true,
  "member_count": "string"
}

Delete

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this organization.

Request

DELETE /api/organizations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:id/

Response

Status 204 No response body

Delete

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this organization.

Request

DELETE /api/organizations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:id/

Response

Status 204 No response body

List all batch exports

Required API key scopes

batch_export:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/batch_exports

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "team_id": 0,
      "name": "string",
      "model": "events",
      "destination": {
        "type": "S3",
        "config": null
      },
      "interval": "hour",
      "paused": true,
      "created_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "last_paused_at": "2019-08-24T14:15:22Z",
      "start_at": "2019-08-24T14:15:22Z",
      "end_at": "2019-08-24T14:15:22Z",
      "latest_runs": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "status": "Cancelled",
          "records_completed": -2147483648,
          "latest_error": "string",
          "data_interval_start": "2019-08-24T14:15:22Z",
          "data_interval_end": "2019-08-24T14:15:22Z",
          "cursor": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "finished_at": "2019-08-24T14:15:22Z",
          "last_updated_at": "2019-08-24T14:15:22Z",
          "records_total_count": -2147483648,
          "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
        }
      ],
      "hogql_query": "string",
      "schema": null
    }
  ]
}

Create batch exports

Required API key scopes

batch_export:write

Path parameters

organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Response

Request

POST /api/organizations/:organization_id/batch_exports

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

Retrieve batch exports

Required API key scopes

batch_export:read

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/batch_exports/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

Update batch exports

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Response

Request

PATCH /api/organizations/:organization_id/batch_exports/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/\
	-d team_id="integer"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

Delete batch exports

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request

DELETE /api/organizations/:organization_id/batch_exports/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/

Response

Status 204 No response body

Create batch exports backfill

Trigger a backfill for a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Response

Request

POST /api/organizations/:organization_id/batch_exports/:id/backfill

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/backfill/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

Retrieve batch exports logs

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/batch_exports/:id/logs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/logs/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

Create batch exports pause

Pause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Response

Request

POST /api/organizations/:organization_id/batch_exports/:id/pause

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/pause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

Create batch exports unpause

Unpause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Response

Request

POST /api/organizations/:organization_id/batch_exports/:id/unpause

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/batch_exports/:id/unpause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "team_id": 0,
  "name": "string",
  "model": "events",
  "destination": {
    "type": "S3",
    "config": null
  },
  "interval": "hour",
  "paused": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "last_paused_at": "2019-08-24T14:15:22Z",
  "start_at": "2019-08-24T14:15:22Z",
  "end_at": "2019-08-24T14:15:22Z",
  "latest_runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "Cancelled",
      "records_completed": -2147483648,
      "latest_error": "string",
      "data_interval_start": "2019-08-24T14:15:22Z",
      "data_interval_end": "2019-08-24T14:15:22Z",
      "cursor": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z",
      "last_updated_at": "2019-08-24T14:15:22Z",
      "records_total_count": -2147483648,
      "batch_export": "0fa0a8a1-f280-4977-8bb4-bc7801a6902f"
    }
  ],
  "hogql_query": "string",
  "schema": null
}

List all domains

Required API key scopes

organization:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/domains

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/domains/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "domain": "string",
      "is_verified": true,
      "verified_at": "2019-08-24T14:15:22Z",
      "verification_challenge": "string",
      "jit_provisioning_enabled": true,
      "sso_enforcement": "string",
      "has_saml": true,
      "saml_entity_id": "string",
      "saml_acs_url": "string",
      "saml_x509_cert": "string"
    }
  ]
}

Create domains

Required API key scopes

organization:write

Path parameters

organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string

Response

Request

POST /api/organizations/:organization_id/domains

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/domains/\
	-d domain="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

Retrieve domains

Required API key scopes

organization:read

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/domains/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/domains/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

Update domains

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string

Response

Request

PATCH /api/organizations/:organization_id/domains/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/domains/:id/\
	-d domain="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

Delete domains

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Request

DELETE /api/organizations/:organization_id/domains/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/domains/:id/

Response

Status 204 No response body

Create domains verify

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string

Response

Request

POST /api/organizations/:organization_id/domains/:id/verify

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/domains/:id/verify/\
	-d domain="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

List all invites

Required API key scopes

organization_member:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/invites

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/invites/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "target_email": "user@example.com",
      "first_name": "string",
      "emailing_attempt_made": true,
      "level": 1,
      "is_expired": true,
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        }
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "message": "string",
      "private_project_access": null,
      "send_email": true
    }
  ]
}

Create invites

Required API key scopes

organization_member:write

Path parameters

organization_id
string

Request parameters

target_email
string
first_name
string
level
message
string
private_project_access
List of team IDs and corresponding access levels to private projects.
send_email
boolean
Default:

Response

Request

POST /api/organizations/:organization_id/invites

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/invites/\
	-d target_email="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "target_email": "user@example.com",
  "first_name": "string",
  "emailing_attempt_made": true,
  "level": 1,
  "is_expired": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "message": "string",
  "private_project_access": null,
  "send_email": true
}

Delete invites

Required API key scopes

organization_member:write

Path parameters

id
string
A UUID string identifying this organization invite.
organization_id
string

Request

DELETE /api/organizations/:organization_id/invites/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/invites/:id/

Response

Status 204 No response body

Create invites bulk

Required API key scopes

organization_member:write

Path parameters

organization_id
string

Request parameters

target_email
string
first_name
string
level
message
string
private_project_access
List of team IDs and corresponding access levels to private projects.
send_email
boolean
Default:

Response

Request

POST /api/organizations/:organization_id/invites/bulk

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/invites/bulk/\
	-d target_email="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "target_email": "user@example.com",
  "first_name": "string",
  "emailing_attempt_made": true,
  "level": 1,
  "is_expired": true,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "message": "string",
  "private_project_access": null,
  "send_email": true
}

List all members

Required API key scopes

organization_member:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/members

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/members/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        }
      },
      "level": 1,
      "joined_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "is_2fa_enabled": true,
      "has_social_auth": true
    }
  ]
}

Update members

Required API key scopes

organization_member:write

Path parameters

organization_id
string
user__uuid
string

Request parameters

level

Response

Request

PATCH /api/organizations/:organization_id/members/:user__uuid

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/members/:user__uuid/\
	-d user=undefined

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "level": 1,
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "is_2fa_enabled": true,
  "has_social_auth": true
}

Delete members

Required API key scopes

organization_member:write

Path parameters

organization_id
string
user__uuid
string

Request

DELETE /api/organizations/:organization_id/members/:user__uuid

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/members/:user__uuid/

Response

Status 204 No response body

List all pipeline destinations

Required API key scopes

plugin:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "plugin_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null
    }
  ]
}

Create pipeline destinations

Required API key scopes

plugin:write

Path parameters

organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_destinations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/\
	-d plugin_type=undefined

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline destinations

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline destinations

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_destinations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Delete pipeline destinations

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/pipeline_destinations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/

Response

Status 204 No response body

Retrieve pipeline destinations check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/check_for_updates/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline destinations source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/source/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline destinations update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_destinations/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Create pipeline destinations upgrade

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_destinations/:id/upgrade

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline destinations activity

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline destinations exports unsubscribe configs

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/exports_unsubscribe_configs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/exports_unsubscribe_configs/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline destinations repository

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/repository/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline destinations unused

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_destinations/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_destinations/unused/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

List all pipeline frontend apps

Required API key scopes

plugin:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "plugin_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null
    }
  ]
}

Create pipeline frontend apps

Required API key scopes

plugin:write

Path parameters

organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_frontend_apps

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/\
	-d plugin_type=undefined

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline frontend apps

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline frontend apps

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_frontend_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Delete pipeline frontend apps

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/pipeline_frontend_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/

Response

Status 204 No response body

Retrieve pipeline frontend apps check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/check_for_updates/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline frontend apps source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/source/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline frontend apps update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_frontend_apps/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Create pipeline frontend apps upgrade

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_frontend_apps/:id/upgrade

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline frontend apps activity

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline frontend apps exports unsubscribe configs

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/exports_unsubscribe_configs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/exports_unsubscribe_configs/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline frontend apps repository

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/repository/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline frontend apps unused

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_frontend_apps/unused/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

List all pipeline import apps

Required API key scopes

plugin:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "plugin_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null
    }
  ]
}

Create pipeline import apps

Required API key scopes

plugin:write

Path parameters

organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_import_apps

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/\
	-d plugin_type=undefined

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline import apps

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline import apps

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_import_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Delete pipeline import apps

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/pipeline_import_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/

Response

Status 204 No response body

Retrieve pipeline import apps check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/check_for_updates/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline import apps source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/source/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline import apps update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_import_apps/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Create pipeline import apps upgrade

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_import_apps/:id/upgrade

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline import apps activity

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline import apps exports unsubscribe configs

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/exports_unsubscribe_configs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/exports_unsubscribe_configs/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline import apps repository

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/repository/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline import apps unused

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_import_apps/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_import_apps/unused/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

List all pipeline transformations

Required API key scopes

plugin:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "plugin_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null
    }
  ]
}

Create pipeline transformations

Required API key scopes

plugin:write

Path parameters

organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_transformations

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/\
	-d plugin_type=undefined

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline transformations

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline transformations

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_transformations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Delete pipeline transformations

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/pipeline_transformations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/

Response

Status 204 No response body

Retrieve pipeline transformations check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/check_for_updates/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline transformations source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/source/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update pipeline transformations update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_transformations/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Create pipeline transformations upgrade

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_transformations/:id/upgrade

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline transformations activity

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline transformations exports unsubscribe configs

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/exports_unsubscribe_configs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/exports_unsubscribe_configs/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline transformations repository

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/repository/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve pipeline transformations unused

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_transformations/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/pipeline_transformations/unused/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

List all plugins

Required API key scopes

plugin:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/plugins

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "plugin_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null
    }
  ]
}

Create plugins

Required API key scopes

plugin:write

Path parameters

organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/plugins

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/\
	-d plugin_type=undefined

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve plugins

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update plugins

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/plugins/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Delete plugins

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/plugins/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/

Response

Status 204 No response body

Retrieve plugins check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/check_for_updates/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve plugins source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/source/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Update plugins update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/plugins/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Create plugins upgrade

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/plugins/:id/upgrade

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve plugins activity

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve plugins exports unsubscribe configs

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/exports_unsubscribe_configs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/exports_unsubscribe_configs/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve plugins repository

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/repository/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve plugins unused

Path parameters

organization_id
string

Response

Request

GET /api/organizations/:organization_id/plugins/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/plugins/unused/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null
}

Retrieve list

Projects for the current organization.

Required API key scopes

project:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/projects

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
      "api_token": "string",
      "name": "string",
      "completed_snippet_onboarding": true,
      "has_completed_onboarding_for": null,
      "ingested_event": true,
      "is_demo": true,
      "timezone": "Africa/Abidjan",
      "access_control": true
    }
  ]
}

Create create

Projects for the current organization.

Required API key scopes

project:write

Path parameters

organization_id
string

Request parameters

app_urls
array
name
string
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_replay_config
access_control
boolean
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean

Response

Request

POST /api/organizations/:organization_id/projects

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/\
	-d uuid="string"

Response

Status 201

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "name": "string",
  "slack_incoming_webhook": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "effective_membership_level": 1,
  "access_control": true,
  "week_start_day": 0,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "live_events_token": "string"
}

Retrieve retrieve

Projects for the current organization.

Required API key scopes

project:read

Path parameters

id
integer
A unique integer value identifying this team (soon to be environment).
organization_id
string

Response

Request

GET /api/organizations/:organization_id/projects/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "name": "string",
  "slack_incoming_webhook": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "effective_membership_level": 1,
  "access_control": true,
  "week_start_day": 0,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "live_events_token": "string"
}

Update partial update

Projects for the current organization.

Required API key scopes

project:write

Path parameters

id
integer
A unique integer value identifying this team (soon to be environment).
organization_id
string

Request parameters

app_urls
array
name
string
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_replay_config
access_control
boolean
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean

Response

Request

PATCH /api/organizations/:organization_id/projects/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/:id/\
	-d uuid="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "name": "string",
  "slack_incoming_webhook": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "effective_membership_level": 1,
  "access_control": true,
  "week_start_day": 0,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "live_events_token": "string"
}

Delete destroy

Projects for the current organization.

Required API key scopes

project:write

Path parameters

id
integer
A unique integer value identifying this team (soon to be environment).
organization_id
string

Request

DELETE /api/organizations/:organization_id/projects/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/:id/

Response

Status 204 No response body

Retrieve activity

Projects for the current organization.

Path parameters

id
integer
A unique integer value identifying this team (soon to be environment).
organization_id
string

Response

Request

GET /api/organizations/:organization_id/projects/:id/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/:id/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "name": "string",
  "slack_incoming_webhook": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "effective_membership_level": 1,
  "access_control": true,
  "week_start_day": 0,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "live_events_token": "string"
}

Retrieve is generating demo data

Projects for the current organization.

Path parameters

id
integer
A unique integer value identifying this team (soon to be environment).
organization_id
string

Response

Request

GET /api/organizations/:organization_id/projects/:id/is_generating_demo_data

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/:id/is_generating_demo_data/

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "name": "string",
  "slack_incoming_webhook": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "effective_membership_level": 1,
  "access_control": true,
  "week_start_day": 0,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "live_events_token": "string"
}

Update reset token

Projects for the current organization.

Path parameters

id
integer
A unique integer value identifying this team (soon to be environment).
organization_id
string

Request parameters

app_urls
array
name
string
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_replay_config
access_control
boolean
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean

Response

Request

PATCH /api/organizations/:organization_id/projects/:id/reset_token

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/projects/:id/reset_token/\
	-d uuid="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "name": "string",
  "slack_incoming_webhook": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "effective_membership_level": 1,
  "access_control": true,
  "week_start_day": 0,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "live_events_token": "string"
}

List all proxy records

Required API key scopes

organization:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/proxy_records

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/proxy_records/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "domain": "string",
      "target_cname": "string",
      "status": "waiting",
      "message": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": 0
    }
  ]
}

Create proxy records

Required API key scopes

organization:write

Path parameters

organization_id
string

Request parameters

domain
string

Response

Request

POST /api/organizations/:organization_id/proxy_records

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/proxy_records/\
	-d domain="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "target_cname": "string",
  "status": "waiting",
  "message": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": 0
}

Retrieve proxy records

Required API key scopes

organization:read

Path parameters

id
string
organization_id
string

Response

Request

GET /api/organizations/:organization_id/proxy_records/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/proxy_records/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "target_cname": "string",
  "status": "waiting",
  "message": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": 0
}

Update proxy records

Required API key scopes

organization:write

Path parameters

id
string
organization_id
string

Request parameters

domain
string

Response

Request

PATCH /api/organizations/:organization_id/proxy_records/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/proxy_records/:id/\
	-d domain="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "target_cname": "string",
  "status": "waiting",
  "message": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_by": 0
}

Delete proxy records

Required API key scopes

organization:write

Path parameters

id
string
organization_id
string

Request

DELETE /api/organizations/:organization_id/proxy_records/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/proxy_records/:id/

Response

Status 204 No response body

List all roles

Required API key scopes

organization:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/roles

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "feature_flags_access_level": 21,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        }
      },
      "members": "string",
      "associated_flags": "string"
    }
  ]
}

Create roles

Required API key scopes

organization:write

Path parameters

organization_id
string

Request parameters

name
string
feature_flags_access_level

Response

Request

POST /api/organizations/:organization_id/roles

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/\
	-d name="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "feature_flags_access_level": 21,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "members": "string",
  "associated_flags": "string"
}

Retrieve roles

Required API key scopes

organization:read

Path parameters

id
string
A UUID string identifying this role.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/roles/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "feature_flags_access_level": 21,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "members": "string",
  "associated_flags": "string"
}

Update roles

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this role.
organization_id
string

Request parameters

name
string
feature_flags_access_level

Response

Request

PATCH /api/organizations/:organization_id/roles/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/:id/\
	-d name="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "feature_flags_access_level": 21,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "members": "string",
  "associated_flags": "string"
}

Delete roles

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this role.
organization_id
string

Request

DELETE /api/organizations/:organization_id/roles/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/:id/

Response

Status 204 No response body

List all roles role memberships

Required API key scopes

organization:read

Path parameters

organization_id
string
role_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/roles/:role_id/role_memberships

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/:role_id/role_memberships/

Response

Status 200

RESPONSE

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
      "organization_member": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "user": {
          "id": 0,
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "distinct_id": "string",
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "is_email_verified": true,
          "hedgehog_config": {
            "property1": null,
            "property2": null
          }
        },
        "level": 1,
        "joined_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "is_2fa_enabled": true,
        "has_social_auth": true
      },
      "user": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        }
      },
      "joined_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
    }
  ]
}

Create roles role memberships

Required API key scopes

organization:write

Path parameters

organization_id
string
role_id
string

Request parameters

user_uuid
string

Response

Request

POST /api/organizations/:organization_id/roles/:role_id/role_memberships

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/:role_id/role_memberships/\
	-d user_uuid="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  "organization_member": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "user": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {
        "property1": null,
        "property2": null
      }
    },
    "level": 1,
    "joined_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "is_2fa_enabled": true,
    "has_social_auth": true
  },
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    }
  },
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
}

Delete roles role memberships

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this role membership.
organization_id
string
role_id
string

Request

DELETE /api/organizations/:organization_id/roles/:role_id/role_memberships/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/organizations/:organization_id/roles/:role_id/role_memberships/:id/