Projects API Reference

Docs
API
Projects

Projects

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

Projects for the current organization.

Endpoints

`GET`	`/api/projects/`
`POST`	`/api/projects/`
`GET`	`/api/projects/:id/`
`PATCH`	`/api/projects/:id/`
`DELETE`	`/api/projects/:id/`

Retrieve

Query Parameters

limit
integer
offset
integer

Response

Request

GET /api/projects

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

Response

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": "stringstri",
      "name": "string",
      "completed_snippet_onboarding": true,
      "ingested_event": true,
      "is_demo": true,
      "timezone": "Africa/Abidjan",
      "access_control": true,
      "effective_membership_level": 1
    }
  ]
}

Create

Request Parameters

app_urls
array
name
string
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
object
test_account_filters_default_checked
boolean
path_cleaning_filters
object
timezone
string
One of: "Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau""Africa/Blantyre""Africa/Brazzaville""Africa/Bujumbura""Africa/Cairo""Africa/Casablanca""Africa/Ceuta""Africa/Conakry""Africa/Dakar""Africa/Dar_es_Salaam""Africa/Djibouti""Africa/Douala""Africa/El_Aaiun""Africa/Freetown""Africa/Gaborone""Africa/Harare""Africa/Johannesburg""Africa/Juba""Africa/Kampala""Africa/Khartoum""Africa/Kigali""Africa/Kinshasa""Africa/Lagos""Africa/Libreville""Africa/Lome""Africa/Luanda""Africa/Lubumbashi""Africa/Lusaka""Africa/Malabo""Africa/Maputo""Africa/Maseru""Africa/Mbabane""Africa/Mogadishu""Africa/Monrovia""Africa/Nairobi""Africa/Ndjamena""Africa/Niamey""Africa/Nouakchott""Africa/Ouagadougou""Africa/Porto-Novo""Africa/Sao_Tome""Africa/Tripoli""Africa/Tunis""Africa/Windhoek""America/Adak""America/Anchorage""America/Anguilla""America/Antigua""America/Araguaina""America/Argentina/Buenos_Aires""America/Argentina/Catamarca""America/Argentina/Cordoba""America/Argentina/Jujuy""America/Argentina/La_Rioja""America/Argentina/Mendoza""America/Argentina/Rio_Gallegos""America/Argentina/Salta""America/Argentina/San_Juan""America/Argentina/San_Luis""America/Argentina/Tucuman""America/Argentina/Ushuaia""America/Aruba""America/Asuncion""America/Atikokan""America/Bahia""America/Bahia_Banderas""America/Barbados""America/Belem""America/Belize""America/Blanc-Sablon""America/Boa_Vista""America/Bogota""America/Boise""America/Cambridge_Bay""America/Campo_Grande""America/Cancun""America/Caracas""America/Cayenne""America/Cayman""America/Chicago""America/Chihuahua""America/Costa_Rica""America/Creston""America/Cuiaba""America/Curacao""America/Danmarkshavn""America/Dawson""America/Dawson_Creek""America/Denver""America/Detroit""America/Dominica""America/Edmonton""America/Eirunepe""America/El_Salvador""America/Fort_Nelson""America/Fortaleza""America/Glace_Bay""America/Goose_Bay""America/Grand_Turk""America/Grenada""America/Guadeloupe""America/Guatemala""America/Guayaquil""America/Guyana""America/Halifax""America/Havana""America/Hermosillo""America/Indiana/Indianapolis""America/Indiana/Knox""America/Indiana/Marengo""America/Indiana/Petersburg""America/Indiana/Tell_City""America/Indiana/Vevay""America/Indiana/Vincennes""America/Indiana/Winamac""America/Inuvik""America/Iqaluit""America/Jamaica""America/Juneau""America/Kentucky/Louisville""America/Kentucky/Monticello""America/Kralendijk""America/La_Paz""America/Lima""America/Los_Angeles""America/Lower_Princes""America/Maceio""America/Managua""America/Manaus""America/Marigot""America/Martinique""America/Matamoros""America/Mazatlan""America/Menominee""America/Merida""America/Metlakatla""America/Mexico_City""America/Miquelon""America/Moncton""America/Monterrey""America/Montevideo""America/Montserrat""America/Nassau""America/New_York""America/Nipigon""America/Nome""America/Noronha""America/North_Dakota/Beulah""America/North_Dakota/Center""America/North_Dakota/New_Salem""America/Nuuk""America/Ojinaga""America/Panama""America/Pangnirtung""America/Paramaribo""America/Phoenix""America/Port-au-Prince""America/Port_of_Spain""America/Porto_Velho""America/Puerto_Rico""America/Punta_Arenas""America/Rainy_River""America/Rankin_Inlet""America/Recife""America/Regina""America/Resolute""America/Rio_Branco""America/Santarem""America/Santiago""America/Santo_Domingo""America/Sao_Paulo""America/Scoresbysund""America/Sitka""America/St_Barthelemy""America/St_Johns""America/St_Kitts""America/St_Lucia""America/St_Thomas""America/St_Vincent""America/Swift_Current""America/Tegucigalpa""America/Thule""America/Thunder_Bay""America/Tijuana""America/Toronto""America/Tortola""America/Vancouver""America/Whitehorse""America/Winnipeg""America/Yakutat""America/Yellowknife""Antarctica/Casey""Antarctica/Davis""Antarctica/DumontDUrville""Antarctica/Macquarie""Antarctica/Mawson""Antarctica/McMurdo""Antarctica/Palmer""Antarctica/Rothera""Antarctica/Syowa""Antarctica/Troll""Antarctica/Vostok""Arctic/Longyearbyen""Asia/Aden""Asia/Almaty""Asia/Amman""Asia/Anadyr""Asia/Aqtau""Asia/Aqtobe""Asia/Ashgabat""Asia/Atyrau""Asia/Baghdad""Asia/Bahrain""Asia/Baku""Asia/Bangkok""Asia/Barnaul""Asia/Beirut""Asia/Bishkek""Asia/Brunei""Asia/Chita""Asia/Choibalsan""Asia/Colombo""Asia/Damascus""Asia/Dhaka""Asia/Dili""Asia/Dubai""Asia/Dushanbe""Asia/Famagusta""Asia/Gaza""Asia/Hebron""Asia/Ho_Chi_Minh""Asia/Hong_Kong""Asia/Hovd""Asia/Irkutsk""Asia/Jakarta""Asia/Jayapura""Asia/Jerusalem""Asia/Kabul""Asia/Kamchatka""Asia/Karachi""Asia/Kathmandu""Asia/Khandyga""Asia/Kolkata""Asia/Krasnoyarsk""Asia/Kuala_Lumpur""Asia/Kuching""Asia/Kuwait""Asia/Macau""Asia/Magadan""Asia/Makassar""Asia/Manila""Asia/Muscat""Asia/Nicosia""Asia/Novokuznetsk""Asia/Novosibirsk""Asia/Omsk""Asia/Oral""Asia/Phnom_Penh""Asia/Pontianak""Asia/Pyongyang""Asia/Qatar""Asia/Qostanay""Asia/Qyzylorda""Asia/Riyadh""Asia/Sakhalin""Asia/Samarkand""Asia/Seoul""Asia/Shanghai""Asia/Singapore""Asia/Srednekolymsk""Asia/Taipei""Asia/Tashkent""Asia/Tbilisi""Asia/Tehran""Asia/Thimphu""Asia/Tokyo""Asia/Tomsk""Asia/Ulaanbaatar""Asia/Urumqi""Asia/Ust-Nera""Asia/Vientiane""Asia/Vladivostok""Asia/Yakutsk""Asia/Yangon""Asia/Yekaterinburg""Asia/Yerevan""Atlantic/Azores""Atlantic/Bermuda""Atlantic/Canary""Atlantic/Cape_Verde""Atlantic/Faroe""Atlantic/Madeira""Atlantic/Reykjavik""Atlantic/South_Georgia""Atlantic/St_Helena""Atlantic/Stanley""Australia/Adelaide""Australia/Brisbane""Australia/Broken_Hill""Australia/Darwin""Australia/Eucla""Australia/Hobart""Australia/Lindeman""Australia/Lord_Howe""Australia/Melbourne""Australia/Perth""Australia/Sydney""Canada/Atlantic""Canada/Central""Canada/Eastern""Canada/Mountain""Canada/Newfoundland""Canada/Pacific""Europe/Amsterdam""Europe/Andorra""Europe/Astrakhan""Europe/Athens""Europe/Belgrade""Europe/Berlin""Europe/Bratislava""Europe/Brussels""Europe/Bucharest""Europe/Budapest""Europe/Busingen""Europe/Chisinau""Europe/Copenhagen""Europe/Dublin""Europe/Gibraltar""Europe/Guernsey""Europe/Helsinki""Europe/Isle_of_Man""Europe/Istanbul""Europe/Jersey""Europe/Kaliningrad""Europe/Kiev""Europe/Kirov""Europe/Lisbon""Europe/Ljubljana""Europe/London""Europe/Luxembourg""Europe/Madrid""Europe/Malta""Europe/Mariehamn""Europe/Minsk""Europe/Monaco""Europe/Moscow""Europe/Oslo""Europe/Paris""Europe/Podgorica""Europe/Prague""Europe/Riga""Europe/Rome""Europe/Samara""Europe/San_Marino""Europe/Sarajevo""Europe/Saratov""Europe/Simferopol""Europe/Skopje""Europe/Sofia""Europe/Stockholm""Europe/Tallinn""Europe/Tirane""Europe/Ulyanovsk""Europe/Uzhgorod""Europe/Vaduz""Europe/Vatican""Europe/Vienna""Europe/Vilnius""Europe/Volgograd""Europe/Warsaw""Europe/Zagreb""Europe/Zaporozhye""Europe/Zurich""GMT""Indian/Antananarivo""Indian/Chagos""Indian/Christmas""Indian/Cocos""Indian/Comoro""Indian/Kerguelen""Indian/Mahe""Indian/Maldives""Indian/Mauritius""Indian/Mayotte""Indian/Reunion""Pacific/Apia""Pacific/Auckland""Pacific/Bougainville""Pacific/Chatham""Pacific/Chuuk""Pacific/Easter""Pacific/Efate""Pacific/Enderbury""Pacific/Fakaofo""Pacific/Fiji""Pacific/Funafuti""Pacific/Galapagos""Pacific/Gambier""Pacific/Guadalcanal""Pacific/Guam""Pacific/Honolulu""Pacific/Kiritimati""Pacific/Kosrae""Pacific/Kwajalein""Pacific/Majuro""Pacific/Marquesas""Pacific/Midway""Pacific/Nauru""Pacific/Niue""Pacific/Norfolk""Pacific/Noumea""Pacific/Pago_Pago""Pacific/Palau""Pacific/Pitcairn""Pacific/Pohnpei""Pacific/Port_Moresby""Pacific/Rarotonga""Pacific/Saipan""Pacific/Tahiti""Pacific/Tarawa""Pacific/Tongatapu""Pacific/Wake""Pacific/Wallis""US/Alaska""US/Arizona""US/Central""US/Eastern""US/Hawaii""US/Mountain""US/Pacific""UTC"
data_attributes
object
person_display_name_properties
array
correlation_config
object
session_recording_opt_in
boolean
capture_console_log_opt_in
boolean
access_control
boolean
primary_dashboard
integer
live_events_columns
array
recording_domains
array

Response

Request

POST /api/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/projects/\
	-d uuid="string"

Response

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": {
    "property1": null,
    "property2": null
  },
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": {
    "property1": null,
    "property2": null
  },
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": {
    "property1": null,
    "property2": null
  },
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": {
    "property1": null,
    "property2": null
  },
  "session_recording_opt_in": true,
  "capture_console_log_opt_in": true,
  "effective_membership_level": 1,
  "access_control": true,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ]
}

Retrieve

Path Parameters

id
integer

Response

Request

GET /api/projects/:id

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

Response

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": {
    "property1": null,
    "property2": null
  },
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": {
    "property1": null,
    "property2": null
  },
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": {
    "property1": null,
    "property2": null
  },
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": {
    "property1": null,
    "property2": null
  },
  "session_recording_opt_in": true,
  "capture_console_log_opt_in": true,
  "effective_membership_level": 1,
  "access_control": true,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ]
}

Update partial

Path Parameters

id
integer

Request Parameters

app_urls
array
name
string
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
object
test_account_filters_default_checked
boolean
path_cleaning_filters
object
timezone
string
One of: "Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau""Africa/Blantyre""Africa/Brazzaville""Africa/Bujumbura""Africa/Cairo""Africa/Casablanca""Africa/Ceuta""Africa/Conakry""Africa/Dakar""Africa/Dar_es_Salaam""Africa/Djibouti""Africa/Douala""Africa/El_Aaiun""Africa/Freetown""Africa/Gaborone""Africa/Harare""Africa/Johannesburg""Africa/Juba""Africa/Kampala""Africa/Khartoum""Africa/Kigali""Africa/Kinshasa""Africa/Lagos""Africa/Libreville""Africa/Lome""Africa/Luanda""Africa/Lubumbashi""Africa/Lusaka""Africa/Malabo""Africa/Maputo""Africa/Maseru""Africa/Mbabane""Africa/Mogadishu""Africa/Monrovia""Africa/Nairobi""Africa/Ndjamena""Africa/Niamey""Africa/Nouakchott""Africa/Ouagadougou""Africa/Porto-Novo""Africa/Sao_Tome""Africa/Tripoli""Africa/Tunis""Africa/Windhoek""America/Adak""America/Anchorage""America/Anguilla""America/Antigua""America/Araguaina""America/Argentina/Buenos_Aires""America/Argentina/Catamarca""America/Argentina/Cordoba""America/Argentina/Jujuy""America/Argentina/La_Rioja""America/Argentina/Mendoza""America/Argentina/Rio_Gallegos""America/Argentina/Salta""America/Argentina/San_Juan""America/Argentina/San_Luis""America/Argentina/Tucuman""America/Argentina/Ushuaia""America/Aruba""America/Asuncion""America/Atikokan""America/Bahia""America/Bahia_Banderas""America/Barbados""America/Belem""America/Belize""America/Blanc-Sablon""America/Boa_Vista""America/Bogota""America/Boise""America/Cambridge_Bay""America/Campo_Grande""America/Cancun""America/Caracas""America/Cayenne""America/Cayman""America/Chicago""America/Chihuahua""America/Costa_Rica""America/Creston""America/Cuiaba""America/Curacao""America/Danmarkshavn""America/Dawson""America/Dawson_Creek""America/Denver""America/Detroit""America/Dominica""America/Edmonton""America/Eirunepe""America/El_Salvador""America/Fort_Nelson""America/Fortaleza""America/Glace_Bay""America/Goose_Bay""America/Grand_Turk""America/Grenada""America/Guadeloupe""America/Guatemala""America/Guayaquil""America/Guyana""America/Halifax""America/Havana""America/Hermosillo""America/Indiana/Indianapolis""America/Indiana/Knox""America/Indiana/Marengo""America/Indiana/Petersburg""America/Indiana/Tell_City""America/Indiana/Vevay""America/Indiana/Vincennes""America/Indiana/Winamac""America/Inuvik""America/Iqaluit""America/Jamaica""America/Juneau""America/Kentucky/Louisville""America/Kentucky/Monticello""America/Kralendijk""America/La_Paz""America/Lima""America/Los_Angeles""America/Lower_Princes""America/Maceio""America/Managua""America/Manaus""America/Marigot""America/Martinique""America/Matamoros""America/Mazatlan""America/Menominee""America/Merida""America/Metlakatla""America/Mexico_City""America/Miquelon""America/Moncton""America/Monterrey""America/Montevideo""America/Montserrat""America/Nassau""America/New_York""America/Nipigon""America/Nome""America/Noronha""America/North_Dakota/Beulah""America/North_Dakota/Center""America/North_Dakota/New_Salem""America/Nuuk""America/Ojinaga""America/Panama""America/Pangnirtung""America/Paramaribo""America/Phoenix""America/Port-au-Prince""America/Port_of_Spain""America/Porto_Velho""America/Puerto_Rico""America/Punta_Arenas""America/Rainy_River""America/Rankin_Inlet""America/Recife""America/Regina""America/Resolute""America/Rio_Branco""America/Santarem""America/Santiago""America/Santo_Domingo""America/Sao_Paulo""America/Scoresbysund""America/Sitka""America/St_Barthelemy""America/St_Johns""America/St_Kitts""America/St_Lucia""America/St_Thomas""America/St_Vincent""America/Swift_Current""America/Tegucigalpa""America/Thule""America/Thunder_Bay""America/Tijuana""America/Toronto""America/Tortola""America/Vancouver""America/Whitehorse""America/Winnipeg""America/Yakutat""America/Yellowknife""Antarctica/Casey""Antarctica/Davis""Antarctica/DumontDUrville""Antarctica/Macquarie""Antarctica/Mawson""Antarctica/McMurdo""Antarctica/Palmer""Antarctica/Rothera""Antarctica/Syowa""Antarctica/Troll""Antarctica/Vostok""Arctic/Longyearbyen""Asia/Aden""Asia/Almaty""Asia/Amman""Asia/Anadyr""Asia/Aqtau""Asia/Aqtobe""Asia/Ashgabat""Asia/Atyrau""Asia/Baghdad""Asia/Bahrain""Asia/Baku""Asia/Bangkok""Asia/Barnaul""Asia/Beirut""Asia/Bishkek""Asia/Brunei""Asia/Chita""Asia/Choibalsan""Asia/Colombo""Asia/Damascus""Asia/Dhaka""Asia/Dili""Asia/Dubai""Asia/Dushanbe""Asia/Famagusta""Asia/Gaza""Asia/Hebron""Asia/Ho_Chi_Minh""Asia/Hong_Kong""Asia/Hovd""Asia/Irkutsk""Asia/Jakarta""Asia/Jayapura""Asia/Jerusalem""Asia/Kabul""Asia/Kamchatka""Asia/Karachi""Asia/Kathmandu""Asia/Khandyga""Asia/Kolkata""Asia/Krasnoyarsk""Asia/Kuala_Lumpur""Asia/Kuching""Asia/Kuwait""Asia/Macau""Asia/Magadan""Asia/Makassar""Asia/Manila""Asia/Muscat""Asia/Nicosia""Asia/Novokuznetsk""Asia/Novosibirsk""Asia/Omsk""Asia/Oral""Asia/Phnom_Penh""Asia/Pontianak""Asia/Pyongyang""Asia/Qatar""Asia/Qostanay""Asia/Qyzylorda""Asia/Riyadh""Asia/Sakhalin""Asia/Samarkand""Asia/Seoul""Asia/Shanghai""Asia/Singapore""Asia/Srednekolymsk""Asia/Taipei""Asia/Tashkent""Asia/Tbilisi""Asia/Tehran""Asia/Thimphu""Asia/Tokyo""Asia/Tomsk""Asia/Ulaanbaatar""Asia/Urumqi""Asia/Ust-Nera""Asia/Vientiane""Asia/Vladivostok""Asia/Yakutsk""Asia/Yangon""Asia/Yekaterinburg""Asia/Yerevan""Atlantic/Azores""Atlantic/Bermuda""Atlantic/Canary""Atlantic/Cape_Verde""Atlantic/Faroe""Atlantic/Madeira""Atlantic/Reykjavik""Atlantic/South_Georgia""Atlantic/St_Helena""Atlantic/Stanley""Australia/Adelaide""Australia/Brisbane""Australia/Broken_Hill""Australia/Darwin""Australia/Eucla""Australia/Hobart""Australia/Lindeman""Australia/Lord_Howe""Australia/Melbourne""Australia/Perth""Australia/Sydney""Canada/Atlantic""Canada/Central""Canada/Eastern""Canada/Mountain""Canada/Newfoundland""Canada/Pacific""Europe/Amsterdam""Europe/Andorra""Europe/Astrakhan""Europe/Athens""Europe/Belgrade""Europe/Berlin""Europe/Bratislava""Europe/Brussels""Europe/Bucharest""Europe/Budapest""Europe/Busingen""Europe/Chisinau""Europe/Copenhagen""Europe/Dublin""Europe/Gibraltar""Europe/Guernsey""Europe/Helsinki""Europe/Isle_of_Man""Europe/Istanbul""Europe/Jersey""Europe/Kaliningrad""Europe/Kiev""Europe/Kirov""Europe/Lisbon""Europe/Ljubljana""Europe/London""Europe/Luxembourg""Europe/Madrid""Europe/Malta""Europe/Mariehamn""Europe/Minsk""Europe/Monaco""Europe/Moscow""Europe/Oslo""Europe/Paris""Europe/Podgorica""Europe/Prague""Europe/Riga""Europe/Rome""Europe/Samara""Europe/San_Marino""Europe/Sarajevo""Europe/Saratov""Europe/Simferopol""Europe/Skopje""Europe/Sofia""Europe/Stockholm""Europe/Tallinn""Europe/Tirane""Europe/Ulyanovsk""Europe/Uzhgorod""Europe/Vaduz""Europe/Vatican""Europe/Vienna""Europe/Vilnius""Europe/Volgograd""Europe/Warsaw""Europe/Zagreb""Europe/Zaporozhye""Europe/Zurich""GMT""Indian/Antananarivo""Indian/Chagos""Indian/Christmas""Indian/Cocos""Indian/Comoro""Indian/Kerguelen""Indian/Mahe""Indian/Maldives""Indian/Mauritius""Indian/Mayotte""Indian/Reunion""Pacific/Apia""Pacific/Auckland""Pacific/Bougainville""Pacific/Chatham""Pacific/Chuuk""Pacific/Easter""Pacific/Efate""Pacific/Enderbury""Pacific/Fakaofo""Pacific/Fiji""Pacific/Funafuti""Pacific/Galapagos""Pacific/Gambier""Pacific/Guadalcanal""Pacific/Guam""Pacific/Honolulu""Pacific/Kiritimati""Pacific/Kosrae""Pacific/Kwajalein""Pacific/Majuro""Pacific/Marquesas""Pacific/Midway""Pacific/Nauru""Pacific/Niue""Pacific/Norfolk""Pacific/Noumea""Pacific/Pago_Pago""Pacific/Palau""Pacific/Pitcairn""Pacific/Pohnpei""Pacific/Port_Moresby""Pacific/Rarotonga""Pacific/Saipan""Pacific/Tahiti""Pacific/Tarawa""Pacific/Tongatapu""Pacific/Wake""Pacific/Wallis""US/Alaska""US/Arizona""US/Central""US/Eastern""US/Hawaii""US/Mountain""US/Pacific""UTC"
data_attributes
object
person_display_name_properties
array
correlation_config
object
session_recording_opt_in
boolean
capture_console_log_opt_in
boolean
access_control
boolean
primary_dashboard
integer
live_events_columns
array
recording_domains
array

Response

Request

PATCH /api/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/projects/:id/\
	-d uuid="string"

Response

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": {
    "property1": null,
    "property2": null
  },
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": {
    "property1": null,
    "property2": null
  },
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": {
    "property1": null,
    "property2": null
  },
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": {
    "property1": null,
    "property2": null
  },
  "session_recording_opt_in": true,
  "capture_console_log_opt_in": true,
  "effective_membership_level": 1,
  "access_control": true,
  "has_group_types": true,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ]
}

Delete

Path Parameters

id
integer

Request

DELETE /api/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/projects/:id/

Response

No response

Projects

Endpoints

Retrieve

Query Parameters

Response

Request

Response

Create

Request Parameters

Response

Request

Response

Retrieve

Path Parameters

Response

Request

Response

Update partial

Path Parameters

Request Parameters

Response

Request

Response

Delete

Path Parameters

Request

Response

Questions?

Was this page useful?