Organizations-3 API Reference

Organizations-3

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

Endpoints

`DELETE`	`/api/organizations/:organization_id/members/:user__uuid/`
`GET`	`/api/organizations/:organization_id/members/:user__uuid/scoped_api_keys/`
`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/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/add_product_intent/`
`POST`	`/api/organizations/:organization_id/projects/:id/change_organization/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/complete_product_onboarding/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/delete_secret_token_backup/`
`GET`	`/api/organizations/:organization_id/projects/:id/is_generating_demo_data/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/reset_token/`
`PATCH`	`/api/organizations/:organization_id/projects/:id/rotate_secret_token/`
`GET`	`/api/organizations/:organization_id/proxy_records/`
`POST`	`/api/organizations/:organization_id/proxy_records/`
`GET`	`/api/organizations/:organization_id/proxy_records/:id/`

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" \
    <ph_app_host>/api/organizations/:organization_id/members/:user__uuid/

Response

Status 204 No response body

Retrieve members scoped api keys

Path parameters

organization_id
string
user__uuid
string

Response

Request

GET /api/organizations/:organization_id/members/:user__uuid/scoped_api_keys

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/members/:user__uuid/scoped_api_keys/

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
    },
    "role_at_organization": "engineering"
  },
  "level": 1,
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "is_2fa_enabled": true,
  "has_social_auth": true,
  "last_login": "2019-08-24T14:15:22Z"
}

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" \
    <ph_app_host>/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

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
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" \
    <ph_app_host>/api/organizations/:organization_id/projects/\
	-d organization="string"

Response

Status 201

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Retrieve retrieve

Projects for the current organization.

Required API key scopes

project:read

Path parameters

id
integer
A unique value identifying this project.
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" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Update partial update

Projects for the current organization.

Required API key scopes

project:read

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
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" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Delete destroy

Projects for the current organization.

Required API key scopes

project:write

Path parameters

id
integer
A unique value identifying this project.
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" \
    <ph_app_host>/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 value identifying this project.
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" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/activity/

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Update add product intent

Projects for the current organization.

Required API key scopes

team:read

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
boolean

Response

Request

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

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/add_product_intent/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Create change organization

Projects for the current organization.

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
boolean

Response

Request

POST /api/organizations/:organization_id/projects/:id/change_organization

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/change_organization/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Update complete product onboarding

Projects for the current organization.

Required API key scopes

team:read

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
boolean

Response

Request

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

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/complete_product_onboarding/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Update delete secret token backup

Projects for the current organization.

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
boolean

Response

Request

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

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/delete_secret_token_backup/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Retrieve is generating demo data

Projects for the current organization.

Path parameters

id
integer
A unique value identifying this project.
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" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/is_generating_demo_data/

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Update reset token

Projects for the current organization.

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
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" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/reset_token/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string"
}

Update rotate secret token

Projects for the current organization.

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
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_web_vitals_allowed_metrics
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_recording_masking_config
session_replay_config
survey_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
flags_persistence_default
boolean

Response

Request

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

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/projects/:id/rotate_secret_token/\
	-d organization="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "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_web_vitals_allowed_metrics": null,
  "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": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string",
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "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" \
    <ph_app_host>/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" \
    <ph_app_host>/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" \
    <ph_app_host>/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
}