Core-4 API Reference

Retrieve environments integrations jira projects

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/jira_projects
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/jira_projects/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-4_id}/jira_projects/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations linear teams

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/linear_teams
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/linear_teams/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-4_id}/linear_teams/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations linkedin ads accounts

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/linkedin_ads_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/linkedin_ads_accounts/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-4_id}/linkedin_ads_accounts/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations linkedin ads conversion rules

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/linkedin_ads_conversion_rules
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/linkedin_ads_conversion_rules/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-4_id}/linkedin_ads_conversion_rules/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations twilio phone numbers

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/integrations/:id/twilio_phone_numbers
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/twilio_phone_numbers/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/{core-4_id}/twilio_phone_numbers/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations authorize

Path parameters

environment_id
string

Example request

GET /api/environments/:environment_id/integrations/authorize
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/authorize/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/authorize/".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 integrations domain connect apply url

Unified endpoint for generating Domain Connect apply URLs.

Accepts a context ("email" or "proxy") and the relevant resource ID. The backend resolves the domain, template variables, and service ID based on context, then builds the signed apply URL.

Path parameters

environment_id
string

Request parameters

kind
config

Example request

POST /api/environments/:environment_id/integrations/domain-connect/apply-url
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/domain-connect/apply-url/\
	-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/domain-connect/apply-url/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

Retrieve environments integrations domain connect check

Path parameters

environment_id
string

Example request

GET /api/environments/:environment_id/integrations/domain-connect/check
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/domain-connect/check/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/integrations/domain-connect/check/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

List all environments subscriptions

Required API key scopes

subscription:read

Path parameters

environment_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:environment_id/subscriptions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/subscriptions/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/subscriptions/".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,
      "dashboard": 0,
      "insight": 0,
      "target_type": "email",
      "target_value": "string",
      "frequency": "daily",
      "interval": -2147483648,
      "byweekday": [
        "monday"
      ],
      "bysetpos": -2147483648,
      "count": -2147483648,
      "start_date": "2019-08-24T14:15:22Z",
      "until_date": "2019-08-24T14:15:22Z",
      "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"
      },
      "deleted": true,
      "title": "string",
      "summary": "string",
      "next_delivery_date": "2019-08-24T14:15:22Z",
      "invite_message": "string"
    }
  ]
}

Create environments subscriptions

Required API key scopes

subscription:write

Path parameters

environment_id
string

Request parameters

dashboard
integer
insight
integer
target_type
target_value
string
frequency
interval
integer
byweekday
array
bysetpos
integer
count
integer
start_date
string
until_date
string
deleted
boolean
title
string
invite_message
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": -2147483648,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "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"
  },
  "deleted": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "invite_message": "string"
}

Retrieve environments subscriptions

Required API key scopes

subscription:read

Path parameters

environment_id
string
id
integer

Response

Example request

GET /api/environments/:environment_id/subscriptions/: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/subscriptions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/subscriptions/{core-4_id}/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": -2147483648,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "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"
  },
  "deleted": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "invite_message": "string"
}

Update environments subscriptions

Required API key scopes

subscription:write

Path parameters

environment_id
string
id
integer

Request parameters

dashboard
integer
insight
integer
target_type
target_value
string
frequency
interval
integer
byweekday
array
bysetpos
integer
count
integer
start_date
string
until_date
string
deleted
boolean
title
string
invite_message
string

Response

Example request

PATCH /api/environments/:environment_id/subscriptions/:id
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/subscriptions/:id/\
	-d dashboard="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/subscriptions/{core-4_id}/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"dashboard": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "target_type": "email",
  "target_value": "string",
  "frequency": "daily",
  "interval": -2147483648,
  "byweekday": [
    "monday"
  ],
  "bysetpos": -2147483648,
  "count": -2147483648,
  "start_date": "2019-08-24T14:15:22Z",
  "until_date": "2019-08-24T14:15:22Z",
  "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"
  },
  "deleted": true,
  "title": "string",
  "summary": "string",
  "next_delivery_date": "2019-08-24T14:15:22Z",
  "invite_message": "string"
}

Delete environments subscriptions

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

subscription:write

Path parameters

environment_id
string
id
integer

Example request

DELETE /api/environments/:environment_id/subscriptions/: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/subscriptions/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/subscriptions/{core-4_id}/".format(
        project_id=project_id,
		core-4_id="<the core-4 id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

List all domains

Required API key scopes

organization:read

Path parameters

organization_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/organizations/:organization_id/domains
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/domains/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/organizations/{organization_id}/domains/".format(
        project_id=project_id,
		organization_id="<the organization 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": "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",
      "has_scim": true,
      "scim_enabled": true,
      "scim_base_url": "string",
      "scim_bearer_token": "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
scim_enabled
boolean

Response

Example 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" \
    <ph_app_host>/api/organizations/:organization_id/domains/\
	-d domain="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/organizations/{organization_id}/domains/".format(
        project_id=project_id,
		organization_id="<the organization id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"domain": "string"
	}
).json()

Example 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",
  "has_scim": true,
  "scim_enabled": true,
  "scim_base_url": "string",
  "scim_bearer_token": "string"
}

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

Core-4

Endpoints

Retrieve environments integrations jira projects

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments integrations linear teams

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments integrations linkedin ads accounts

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments integrations linkedin ads conversion rules

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments integrations twilio phone numbers

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments integrations authorize

Path parameters

Example request

Example response

Status 200 No response body

Create environments integrations domain connect apply url

Path parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve environments integrations domain connect check

Path parameters

Example request

Example response

Status 200 No response body

List all environments session recordings sharing

Required API key scopes

Path parameters

Example request

Example response

Status 200

Create environments session recordings sharing passwords

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments session recordings sharing passwords

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create environments session recordings sharing refresh

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

List all environments subscriptions

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create environments subscriptions