Core-3 API Reference

Retrieve environments groups property values

Required API key scopes

group:read

Path parameters

environment_id
string

Example request

GET /api/environments/:environment_id/groups/property_values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/groups/property_values/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/groups/property_values/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create environments groups update property

Required API key scopes

group:write

Path parameters

environment_id
string

Query parameters

group_key
string
group_type_index
integer

Request parameters

group_type_index
integer
group_key
string
group_properties

Example request

POST /api/environments/:environment_id/groups/update_property
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/environments/:environment_id/groups/update_property/\
	-d group_type_index="integer",\
	-d group_key="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/groups/update_property/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"group_type_index": "integer",
		"group_key": "string"
	}
).json()

Example response

Status 200 No response body

List all environments integrations

Required API key scopes

integration:read

Path parameters

environment_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:environment_id/integrations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example 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,
      "kind": "slack",
      "config": null,
      "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
        },
        "role_at_organization": "engineering"
      },
      "errors": "string",
      "display_name": "string"
    }
  ]
}

Create environments integrations

Required API key scopes

integration:write

Path parameters

environment_id
string

Request parameters

kind
config

Response

Example request

POST /api/environments/:environment_id/integrations
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/environments/:environment_id/integrations/\
	-d kind=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/integrations/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 201

RESPONSE
{
  "id": 0,
  "kind": "slack",
  "config": null,
  "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
    },
    "role_at_organization": "engineering"
  },
  "errors": "string",
  "display_name": "string"
}

Retrieve environments integrations

Required API key scopes

integration:read

Path parameters

environment_id
string
id
integer

Response

Example request

GET /api/environments/:environment_id/integrations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "kind": "slack",
  "config": null,
  "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
    },
    "role_at_organization": "engineering"
  },
  "errors": "string",
  "display_name": "string"
}

Delete environments integrations

Required API key scopes

integration:write

Path parameters

environment_id
string
id
integer

Example request

DELETE /api/environments/:environment_id/integrations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve environments integrations channels

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/channels
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/channels/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/channels/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

List all environments integrations clickup lists

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/clickup_lists
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/clickup_lists/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/clickup_lists/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations clickup spaces

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/clickup_spaces
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/clickup_spaces/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/clickup_spaces/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations clickup workspaces

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/clickup_workspaces
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/clickup_workspaces/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/clickup_workspaces/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update environments integrations email

Path parameters

environment_id
string
id
integer

Request parameters

kind
config

Response

Example request

PATCH /api/environments/:environment_id/integrations/:id/email
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/email/\
	-d kind=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/email/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "kind": "slack",
  "config": null,
  "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
    },
    "role_at_organization": "engineering"
  },
  "errors": "string",
  "display_name": "string"
}

Create environments integrations email verify

Path parameters

environment_id
string
id
integer

Request parameters

kind
config

Example request

POST /api/environments/:environment_id/integrations/:id/email/verify
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/environments/:environment_id/integrations/:id/email/verify/\
	-d kind=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/email/verify/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

Retrieve environments integrations github repos

Required API key scopes

integration:read

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/github_repos
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/github_repos/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/github_repos/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations google accessible accounts

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/google_accessible_accounts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/google_accessible_accounts/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/google_accessible_accounts/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations google conversion actions

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/google_conversion_actions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/integrations/:id/google_conversion_actions/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-3_id}/google_conversion_actions/".format(
        project_id=project_id,
		core-3_id="<the core-3 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

`GET`
`GET`
`POST`
`GET`
`POST`
`DELETE`
`POST`
`GET`
`POST`
`GET`
`DELETE`
`GET`
`GET`
`GET`
`GET`
`PATCH`
`POST`
`GET`
`GET`
`GET`

Core-3

Endpoints

Retrieve environments groups property values

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments groups related

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Create environments groups update property

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

List all environments insights sharing

Required API key scopes

Path parameters

Example request

Example response

Status 200

Create environments insights sharing passwords

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments insights sharing passwords

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create environments insights sharing refresh

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

List all environments integrations

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create environments integrations

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve environments integrations

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Delete environments integrations

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body