Integrations API Reference

Integrations

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

Endpoints

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

Also available via the PostHog MCP server:
integrations-list — List integrations

Required API key scopes

integration:read

Query parameters

kind
string
One of: "anthropic""apns""azure-blob""bing-ads""clickup""customerio-app""customerio-track""customerio-webhook""databricks""email""firebase""github""gitlab""google-ads""google-cloud-service-account""google-cloud-storage""google-pubsub""google-sheets""hubspot""intercom""jira""linear""linkedin-ads""meta-ads""pinterest-ads""postgresql""reddit-ads""salesforce""slack""slack-posthog-code""snapchat""stripe""tiktok-ads""twilio""vercel"
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
    ),
    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": "anthropic",
      "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": {},
        "role_at_organization": "engineering"
      },
      "errors": "string",
      "display_name": "string"
    }
  ]
}

List all environments integrations

Also available via the PostHog MCP server:
integrations-list — List integrations

Required API key scopes

integration:read

Query parameters

kind
string
One of: "anthropic""apns""azure-blob""bing-ads""clickup""customerio-app""customerio-track""customerio-webhook""databricks""email""firebase""github""gitlab""google-ads""google-cloud-service-account""google-cloud-storage""google-pubsub""google-sheets""hubspot""intercom""jira""linear""linkedin-ads""meta-ads""pinterest-ads""postgresql""reddit-ads""salesforce""slack""slack-posthog-code""snapchat""stripe""tiktok-ads""twilio""vercel"
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
    ),
    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": "anthropic",
      "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": {},
        "role_at_organization": "engineering"
      },
      "errors": "string",
      "display_name": "string"
    }
  ]
}

Create environments integrations

Required API key scopes

integration:write

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
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 201

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

Create environments integrations

Required API key scopes

integration:write

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
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 201

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

Retrieve environments integrations

Required API key scopes

integration:read

Path parameters

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/{integration_id}/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

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

Retrieve environments integrations

Required API key scopes

integration:read

Path parameters

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/{integration_id}/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

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

Delete environments integrations

Required API key scopes

integration:write

Path parameters

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/{integration_id}/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Delete environments integrations

Required API key scopes

integration:write

Path parameters

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/{integration_id}/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve environments integrations anthropic managed agent envs

Required API key scopes

integration:read

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve environments integrations anthropic managed agent envs

Required API key scopes

integration:read

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve environments integrations anthropic managed agent vaults

Required API key scopes

integration:read

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve environments integrations anthropic managed agent vaults

Required API key scopes

integration:read

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve environments integrations anthropic managed agents

Required API key scopes

integration:read

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve environments integrations anthropic managed agents

Required API key scopes

integration:read

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve environments integrations channels

Also available via the PostHog MCP server:
integrations-channels-retrieve — List integration channels

Required API key scopes

integration:read

Path parameters

id
integer

Query parameters

limit
integer
Default: 50
offset
integer
Default: 0
search
string
Default:

Response

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/{integration_id}/channels/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "channels": [
    {
      "id": "string",
      "name": "string",
      "is_private": true,
      "is_member": true,
      "is_ext_shared": true,
      "is_private_without_access": true
    }
  ],
  "lastRefreshedAt": "string",
  "has_more": true
}

Retrieve environments integrations channels

Also available via the PostHog MCP server:
integrations-channels-retrieve — List integration channels

Required API key scopes

integration:read

Path parameters

id
integer

Query parameters

limit
integer
Default: 50
offset
integer
Default: 0
search
string
Default:

Response

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/{integration_id}/channels/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "channels": [
    {
      "id": "string",
      "name": "string",
      "is_private": true,
      "is_member": true,
      "is_ext_shared": true,
      "is_private_without_access": true
    }
  ],
  "lastRefreshedAt": "string",
  "has_more": true
}

List all environments integrations clickup lists

Path parameters

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/{integration_id}/clickup_lists/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

List all environments integrations clickup lists

Path parameters

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/{integration_id}/clickup_lists/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations clickup spaces

Path parameters

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/{integration_id}/clickup_spaces/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments integrations clickup spaces

Path parameters

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/{integration_id}/clickup_spaces/".format(
        project_id=project_id,
		integration_id="<the integration id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()