Integrations-3 API Reference

Integrations-3

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

Endpoints

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

← Previous pageNext page →

Retrieve 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/projects/:project_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/projects/:project_id/integrations/:id/channels/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/integrations/{integrations-3_id}/channels/".format(
        project_id=project_id,
		integrations-3_id="<the integrations-3 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 integrations clickup lists

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations clickup spaces

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations clickup workspaces

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Update integrations email

Path parameters

id
integer

Request parameters

kind
config

Response

Example request

PATCH /api/projects/:project_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/projects/:project_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/projects/{project_id}/integrations/{integrations-3_id}/email/".format(
        project_id=project_id,
		integrations-3_id="<the integrations-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).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"
}

Create integrations email verify

Path parameters

id
integer

Request parameters

kind
config

Example request

POST /api/projects/:project_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/projects/:project_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/projects/{project_id}/integrations/{integrations-3_id}/email/verify/".format(
        project_id=project_id,
		integrations-3_id="<the integrations-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

Retrieve integrations github branches

Required API key scopes

integration:read

Path parameters

id
integer

Query parameters

limit
integer
Default: 100
offset
integer
Default: 0
repo
string
search
string
Default:

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "branches": [
    "string"
  ],
  "default_branch": "string",
  "has_more": true
}

Retrieve integrations github repos

Required API key scopes

integration:read

Path parameters

id
integer

Query parameters

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

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "repositories": [
    {
      "id": 0,
      "name": "string",
      "full_name": "string"
    }
  ],
  "has_more": true
}

Create integrations github repos refresh

Required API key scopes

integration:write

Path parameters

id
integer

Response

Example request

POST /api/projects/:project_id/integrations/:id/github_repos/refresh
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/projects/:project_id/integrations/:id/github_repos/refresh/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/integrations/{integrations-3_id}/github_repos/refresh/".format(
        project_id=project_id,
		integrations-3_id="<the integrations-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "repositories": [
    {
      "id": 0,
      "name": "string",
      "full_name": "string"
    }
  ]
}

Retrieve integrations github teams

Required API key scopes

integration:read

Path parameters

id
integer

Query parameters

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

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "teams": [
    {
      "id": 0,
      "slug": "string",
      "name": "string"
    }
  ],
  "has_more": true
}

Retrieve integrations google accessible accounts

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations google conversion actions

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations jira projects

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations linear teams

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations linkedin ads accounts

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations linkedin ads conversion rules

Path parameters

id
integer

Example request

GET /api/projects/:project_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/projects/:project_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/projects/{project_id}/integrations/{integrations-3_id}/linkedin_ads_conversion_rules/".format(
        project_id=project_id,
		integrations-3_id="<the integrations-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve integrations twilio phone numbers

Path parameters

id
integer

Example request

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

Example response

Status 200 No response body

Retrieve integrations authorize

Example request

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

Example response

Status 200 No response body

Create 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.

Request parameters

kind
config

Example request

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

Example response

Status 200 No response body

Retrieve integrations domain connect check

Example request

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

Example response

Status 200 No response body

← Previous pageNext page →